From 291c0997a6a0166dc06f6501d99c4d6521fd3ffb Mon Sep 17 00:00:00 2001 From: Even Stensberg Date: Mon, 1 Jul 2024 19:38:26 +0200 Subject: [PATCH] chore(cspell): grammar fixes (#7735) * chore(cspell): grammar fixes * chore: remove valid words * fix(cspell): resolve linting errors * fix(naming): change filename * fix(cspell): resolve linting errors * fix(spelling): remove wrong word * fix(review): redundant wording --- .cspell.json | 17 ----------------- API.md | 8 ++++---- docs/src/process/cycle.md | 2 +- docs/src/process/version.md | 2 +- e2e/README.md | 6 +++--- e2e/playwright-ci.config.js | 2 +- e2e/playwright-mobile.config.js | 2 +- e2e/tests/framework/exampleTemplate.e2e.spec.js | 4 ++-- src/api/overlays/Dialog.js | 2 +- src/api/overlays/Overlay.js | 6 +++--- src/api/overlays/OverlayAPI.js | 4 ++-- src/api/overlays/ProgressDialog.js | 2 +- src/api/overlays/Selection.js | 2 +- .../overlays/components/OverlayComponent.vue | 6 +++--- src/api/telemetry/TelemetryAPI.js | 6 +++--- src/api/telemetry/TelemetryAPISpec.js | 4 ++-- ...ragePersistance.js => StoragePersistence.js} | 4 ++-- src/api/user/UserAPI.js | 8 ++++---- src/plugins/licenses/plugin.js | 2 +- .../notebook/components/NotebookEmbed.vue | 4 ++-- .../components/NotificationsList.vue | 2 +- .../summaryWidget/src/ConditionEvaluator.js | 2 +- src/plugins/viewDatumAction/ViewDatumAction.js | 2 +- 23 files changed, 41 insertions(+), 58 deletions(-) rename src/api/user/{StoragePersistance.js => StoragePersistence.js} (95%) diff --git a/.cspell.json b/.cspell.json index 39bae60fab..b085166829 100644 --- a/.cspell.json +++ b/.cspell.json @@ -7,24 +7,18 @@ "minmax", "openmct", "datasources", - "recieved", - "evalute", "Sinewave", "deregistration", "unregisters", - "configutation", - "configuation", "codecov", "carryforward", "Chacon", "Straub", "OWASP", "Testathon", - "exploratorily", "Testathons", "testathon", "npmjs", - "publishj", "treeitem", "timespan", "Timespan", @@ -41,14 +35,10 @@ "faultname", "gantt", "sharded", - "perfromance", "MMOC", "codegen", - "Unfortuantely", "viewports", "updatesnapshots", - "excercised", - "Circel", "browsercontexts", "miminum", "testcase", @@ -135,9 +125,7 @@ "tortor", "faucibus", "euismod", - "pratices", "pathing", - "pases", "testcases", "Noneditable", "listitem", @@ -206,16 +194,12 @@ "unlisten", "symbolsfont", "ellipsize", - "dismissable", "TIMESYSTEM", "Metadatas", - "stalenes", - "receieves", "unsub", "callbacktwo", "unsubscribetwo", "telem", - "Telemetery", "unemitted", "granually", "timesystem", @@ -457,7 +441,6 @@ "Userand", "Userbefore", "brdr", - "pushs", "ALPH", "Recents", "Qbert", diff --git a/API.md b/API.md index 6de26c55d1..f7f7b71a62 100644 --- a/API.md +++ b/API.md @@ -713,7 +713,7 @@ openmct.telemetry.addFormat({ A single telemetry point is considered a Datum, and is represented by a standard javascript object. Realtime subscriptions (obtained via **subscribe**) will -invoke the supplied callback once for each telemetry datum recieved. Telemetry +invoke the supplied callback once for each telemetry datum received. Telemetry requests (obtained via **request**) will return a promise for an array of telemetry datums. @@ -738,7 +738,7 @@ section. Limit evaluators allow a telemetry integrator to define which limits exist for a telemetry endpoint and how limits should be applied to telemetry from a given domain object. -A limit evaluator can implement the `evalute` method which is used to define how limits +A limit evaluator can implement the `evaluate` method which is used to define how limits should be applied to telemetry and the `getLimits` method which is used to specify what the limit values are for different limit levels. @@ -1180,7 +1180,7 @@ An example time conductor configuration is provided below. It sets up some default options for the [UTCTimeSystem](https://github.com/nasa/openmct/blob/master/src/plugins/utcTimeSystem/UTCTimeSystem.js) and [LocalTimeSystem](https://github.com/nasa/openmct/blob/master/src/plugins/localTimeSystem/LocalTimeSystem.js), in both fixed mode, and for the [LocalClock](https://github.com/nasa/openmct/blob/master/src/plugins/utcTimeSystem/LocalClock.js) -source. In this configutation, the local clock supports both the UTCTimeSystem +source. In this configuration, the local clock supports both the UTCTimeSystem and LocalTimeSystem. Configuration for fixed bounds mode is specified by omitting a clock key. @@ -1190,7 +1190,7 @@ const ONE_MINUTE = 60 * 1000; openmct.install(openmct.plugins.Conductor({ menuOptions: [ - // 'Fixed' bounds mode configuation for the UTCTimeSystem + // 'Fixed' bounds mode configuration for the UTCTimeSystem { timeSystem: 'utc', bounds: {start: Date.now() - 30 * ONE_MINUTE, end: Date.now()}, diff --git a/docs/src/process/cycle.md b/docs/src/process/cycle.md index 564576beb3..85a8412e84 100644 --- a/docs/src/process/cycle.md +++ b/docs/src/process/cycle.md @@ -133,7 +133,7 @@ emphasis on testing. Multi-user testing, involving as many users as is feasible, plus development team. Open-ended; should verify completed work from this sprint using the sprint branch, test - exploratorily for regressions, et cetera. + exploratory for regressions, et cetera. * [__Long-Duration Test.__](testing/plan.md#long-duration-testing) A test to verify that the software remains stable after running for longer durations. May include some diff --git a/docs/src/process/version.md b/docs/src/process/version.md index 91d57e1638..8fb307a5a1 100644 --- a/docs/src/process/version.md +++ b/docs/src/process/version.md @@ -132,7 +132,7 @@ numbers by the following process: 4. Test the package before publishing by doing `npm publish --dry-run` if necessary. 5. Publish the package to the npmjs registry (e.g. `npm publish --access public`) - NOTE: Use the `--tag unstable` flag to the npm publishj if this is a prerelease. + NOTE: Use the `--tag unstable` flag to the npm publish if this is a prerelease. 6. Confirm the package has been published (e.g. `https://www.npmjs.com/package/openmct`) 5. Update snapshot status in `package.json` 1. Create a new branch off the `master` branch. diff --git a/e2e/README.md b/e2e/README.md index e9f351a64e..f52a5d4131 100644 --- a/e2e/README.md +++ b/e2e/README.md @@ -181,7 +181,7 @@ In addition to the explicit definition of performance tests, we also ensure that ### File Structure -Our file structure follows the type of type of testing being excercised at the e2e layer and files containing test suites which matcher application behavior or our `src` and `example` layout. This area is not well refined as we figure out what works best for closed source and downstream projects. This may change altogether if we move `e2e` to it's own npm package. +Our file structure follows the type of type of testing being exercised at the e2e layer and files containing test suites which matcher application behavior or our `src` and `example` layout. This area is not well refined as we figure out what works best for closed source and downstream projects. This may change altogether if we move `e2e` to it's own npm package. |File Path|Description| |:-:|-| @@ -236,7 +236,7 @@ Current list of test tags: ### Continuous Integration -The cheapest time to catch a bug is pre-merge. Unfortuantely, this is the most expensive time to run all of the tests since each merge event can consist of hundreds of commits. For this reason, we're selective in _what we run_ as much as _when we run it_. +The cheapest time to catch a bug is pre-merge. Unfortunately, this is the most expensive time to run all of the tests since each merge event can consist of hundreds of commits. For this reason, we're selective in _what we run_ as much as _when we run it_. We leverage CircleCI to run tests against each commit and inject the Test Reports which are generated by Playwright so that they team can keep track of flaky and [historical test trends](https://app.circleci.com/insights/github/nasa/openmct/workflows/overall-circleci-commit-status/tests?branch=master&reporting-window=last-30-days) @@ -281,7 +281,7 @@ Playwright has native support for semi-intelligent sharding. Read about it [here We will be adjusting the parallelization of the Per-Commit tests to keep below the 5 minute total runtime threshold. -In addition to the Parallelization of Test Runners (Sharding), we're also running two concurrent threads on every Shard. This is the functional limit of what CircelCI Agents can support from a memory and CPU resource constraint. +In addition to the Parallelization of Test Runners (Sharding), we're also running two concurrent threads on every Shard. This is the functional limit of what CircleCI Agents can support from a memory and CPU resource constraint. So for every commit, Playwright is effectively running 4 x 2 concurrent browsercontexts to keep the overall runtime to a miminum. diff --git a/e2e/playwright-ci.config.js b/e2e/playwright-ci.config.js index affc39313b..f4d07ca651 100644 --- a/e2e/playwright-ci.config.js +++ b/e2e/playwright-ci.config.js @@ -12,7 +12,7 @@ const config = { retries: 2, //Retries 2 times for a total of 3 runs. When running sharded and with max-failures=5, this should ensure that flake is managed without failing the full suite testDir: 'tests', grepInvert: /@mobile/, //Ignore mobile tests - testIgnore: '**/*.perf.spec.js', //Ignore performance tests and define in playwright-perfromance.config.js + testIgnore: '**/*.perf.spec.js', //Ignore performance tests and define in playwright-performance.config.js timeout: 60 * 1000, webServer: { command: 'npm run start:coverage', diff --git a/e2e/playwright-mobile.config.js b/e2e/playwright-mobile.config.js index 036e858578..f8e31bfb8d 100644 --- a/e2e/playwright-mobile.config.js +++ b/e2e/playwright-mobile.config.js @@ -10,7 +10,7 @@ import { fileURLToPath } from 'url'; const config = { retries: 1, //Retries 2 times for a total of 3 runs. When running sharded and with max-failures=5, this should ensure that flake is managed without failing the full suite testDir: 'tests', - testIgnore: '**/*.perf.spec.js', //Ignore performance tests and define in playwright-perfromance.config.js + testIgnore: '**/*.perf.spec.js', //Ignore performance tests and define in playwright-performance.config.js timeout: 30 * 1000, webServer: { command: 'npm run start:coverage', diff --git a/e2e/tests/framework/exampleTemplate.e2e.spec.js b/e2e/tests/framework/exampleTemplate.e2e.spec.js index 3b245fa3c4..fa696b365f 100644 --- a/e2e/tests/framework/exampleTemplate.e2e.spec.js +++ b/e2e/tests/framework/exampleTemplate.e2e.spec.js @@ -22,7 +22,7 @@ /* * This test suite template is to be used when creating new test suites. It will be kept up to date with the latest improvements - * made by the Open MCT team. It will also follow our best pratices as those evolve. Please use this structure as a _reference_ and clear + * made by the Open MCT team. It will also follow our best practices as those evolve. Please use this structure as a _reference_ and clear * or update any references when creating a new test suite! * * To illustrate current best practices, we've included a mocked up test suite for Renaming a Timer domain object. @@ -81,7 +81,7 @@ test.describe('Renaming Timer Object', () => { test('An existing Timer object can be renamed via the 3dot actions menu', async ({ page }) => { const newObjectName = 'Renamed Timer'; - // We've created an example of a shared function which pases the page and newObjectName values + // We've created an example of a shared function which passes the page and newObjectName values await renameTimerFrom3DotMenu(page, timer.url, newObjectName); // Assert that the name has changed in the browser bar to the value we assigned above diff --git a/src/api/overlays/Dialog.js b/src/api/overlays/Dialog.js index 2bdc6891da..cf93e54b8c 100644 --- a/src/api/overlays/Dialog.js +++ b/src/api/overlays/Dialog.js @@ -22,7 +22,7 @@ class Dialog extends Overlay { super({ element: vNode.el, size: 'fit', - dismissable: false, + dismissible: false, ...options }); diff --git a/src/api/overlays/Overlay.js b/src/api/overlays/Overlay.js index 8bdfc83835..7b81f7ddbb 100644 --- a/src/api/overlays/Overlay.js +++ b/src/api/overlays/Overlay.js @@ -15,7 +15,7 @@ class Overlay extends EventEmitter { constructor({ buttons, autoHide = true, - dismissable = true, + dismissible = true, element, onDestroy, onDismiss, @@ -27,7 +27,7 @@ class Overlay extends EventEmitter { this.container.classList.add('l-overlay-wrapper', cssClasses[size]); this.autoHide = autoHide; - this.dismissable = dismissable !== false; + this.dismissible = dismissible !== false; const { destroy } = mount( { @@ -38,7 +38,7 @@ class Overlay extends EventEmitter { dismiss: this.notifyAndDismiss.bind(this), element, buttons, - dismissable: this.dismissable + dismissible: this.dismissible }, template: '' }, diff --git a/src/api/overlays/OverlayAPI.js b/src/api/overlays/OverlayAPI.js index faa7c8752a..08a0b3f09b 100644 --- a/src/api/overlays/OverlayAPI.js +++ b/src/api/overlays/OverlayAPI.js @@ -76,7 +76,7 @@ class OverlayAPI { */ dismissLastOverlay() { let lastOverlay = this.activeOverlays[this.activeOverlays.length - 1]; - if (lastOverlay && lastOverlay.dismissable) { + if (lastOverlay && lastOverlay.dismissible) { lastOverlay.notifyAndDismiss(); } } @@ -89,7 +89,7 @@ class OverlayAPI { * @property {'large'|'small'|'fit'} size The preferred size of the overlay. * @property {Array<{label: string, callback: Function}>} [buttons] Optional array of button objects, each with 'label' and 'callback' properties. * @property {Function} onDestroy Callback to be called when the overlay is destroyed. - * @property {boolean} [dismissable=true] Whether the overlay can be dismissed by pressing 'esc' or clicking outside of it. Defaults to true. + * @property {boolean} [dismissible=true] Whether the overlay can be dismissed by pressing 'esc' or clicking outside of it. Defaults to true. * * @param {OverlayOptions} options - The configuration options for the overlay. * @returns {Overlay} An instance of the Overlay class. diff --git a/src/api/overlays/ProgressDialog.js b/src/api/overlays/ProgressDialog.js index 8183135872..5ca5d05bf5 100644 --- a/src/api/overlays/ProgressDialog.js +++ b/src/api/overlays/ProgressDialog.js @@ -40,7 +40,7 @@ class ProgressDialog extends Overlay { super({ element: vNode.el, size: 'fit', - dismissable: false, + dismissible: false, ...options }); diff --git a/src/api/overlays/Selection.js b/src/api/overlays/Selection.js index 612d9aeefe..f35b305fd5 100644 --- a/src/api/overlays/Selection.js +++ b/src/api/overlays/Selection.js @@ -55,7 +55,7 @@ class Selection extends Overlay { super({ element: component.$el, size: 'fit', - dismissable: false, + dismissible: false, onChange, currentSelection, ...options diff --git a/src/api/overlays/components/OverlayComponent.vue b/src/api/overlays/components/OverlayComponent.vue index 5b2a0dcb06..72941fd022 100644 --- a/src/api/overlays/components/OverlayComponent.vue +++ b/src/api/overlays/components/OverlayComponent.vue @@ -24,7 +24,7 @@