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
This commit is contained in:
Even Stensberg 2024-07-01 19:38:26 +02:00 committed by GitHub
parent 393da7dc62
commit 291c0997a6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
23 changed files with 41 additions and 58 deletions

View File

@ -7,24 +7,18 @@
"minmax", "minmax",
"openmct", "openmct",
"datasources", "datasources",
"recieved",
"evalute",
"Sinewave", "Sinewave",
"deregistration", "deregistration",
"unregisters", "unregisters",
"configutation",
"configuation",
"codecov", "codecov",
"carryforward", "carryforward",
"Chacon", "Chacon",
"Straub", "Straub",
"OWASP", "OWASP",
"Testathon", "Testathon",
"exploratorily",
"Testathons", "Testathons",
"testathon", "testathon",
"npmjs", "npmjs",
"publishj",
"treeitem", "treeitem",
"timespan", "timespan",
"Timespan", "Timespan",
@ -41,14 +35,10 @@
"faultname", "faultname",
"gantt", "gantt",
"sharded", "sharded",
"perfromance",
"MMOC", "MMOC",
"codegen", "codegen",
"Unfortuantely",
"viewports", "viewports",
"updatesnapshots", "updatesnapshots",
"excercised",
"Circel",
"browsercontexts", "browsercontexts",
"miminum", "miminum",
"testcase", "testcase",
@ -135,9 +125,7 @@
"tortor", "tortor",
"faucibus", "faucibus",
"euismod", "euismod",
"pratices",
"pathing", "pathing",
"pases",
"testcases", "testcases",
"Noneditable", "Noneditable",
"listitem", "listitem",
@ -206,16 +194,12 @@
"unlisten", "unlisten",
"symbolsfont", "symbolsfont",
"ellipsize", "ellipsize",
"dismissable",
"TIMESYSTEM", "TIMESYSTEM",
"Metadatas", "Metadatas",
"stalenes",
"receieves",
"unsub", "unsub",
"callbacktwo", "callbacktwo",
"unsubscribetwo", "unsubscribetwo",
"telem", "telem",
"Telemetery",
"unemitted", "unemitted",
"granually", "granually",
"timesystem", "timesystem",
@ -457,7 +441,6 @@
"Userand", "Userand",
"Userbefore", "Userbefore",
"brdr", "brdr",
"pushs",
"ALPH", "ALPH",
"Recents", "Recents",
"Qbert", "Qbert",

8
API.md
View File

@ -713,7 +713,7 @@ openmct.telemetry.addFormat({
A single telemetry point is considered a Datum, and is represented by a standard A single telemetry point is considered a Datum, and is represented by a standard
javascript object. Realtime subscriptions (obtained via **subscribe**) will 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 requests (obtained via **request**) will return a promise for an array of
telemetry datums. telemetry datums.
@ -738,7 +738,7 @@ section.
Limit evaluators allow a telemetry integrator to define which limits exist for a 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. 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 should be applied to telemetry and the `getLimits` method which is used to specify
what the limit values are for different limit levels. 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) 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), 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) 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 and LocalTimeSystem. Configuration for fixed bounds mode is specified by omitting
a clock key. a clock key.
@ -1190,7 +1190,7 @@ const ONE_MINUTE = 60 * 1000;
openmct.install(openmct.plugins.Conductor({ openmct.install(openmct.plugins.Conductor({
menuOptions: [ menuOptions: [
// 'Fixed' bounds mode configuation for the UTCTimeSystem // 'Fixed' bounds mode configuration for the UTCTimeSystem
{ {
timeSystem: 'utc', timeSystem: 'utc',
bounds: {start: Date.now() - 30 * ONE_MINUTE, end: Date.now()}, bounds: {start: Date.now() - 30 * ONE_MINUTE, end: Date.now()},

View File

@ -133,7 +133,7 @@ emphasis on testing.
Multi-user testing, involving as many users as Multi-user testing, involving as many users as
is feasible, plus development team. Open-ended; should verify is feasible, plus development team. Open-ended; should verify
completed work from this sprint using the sprint branch, test 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 * [__Long-Duration Test.__](testing/plan.md#long-duration-testing) A
test to verify that the software remains test to verify that the software remains
stable after running for longer durations. May include some stable after running for longer durations. May include some

View File

@ -132,7 +132,7 @@ numbers by the following process:
4. Test the package before publishing by doing `npm publish --dry-run` 4. Test the package before publishing by doing `npm publish --dry-run`
if necessary. if necessary.
5. Publish the package to the npmjs registry (e.g. `npm publish --access public`) 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`) 6. Confirm the package has been published (e.g. `https://www.npmjs.com/package/openmct`)
5. Update snapshot status in `package.json` 5. Update snapshot status in `package.json`
1. Create a new branch off the `master` branch. 1. Create a new branch off the `master` branch.

View File

@ -181,7 +181,7 @@ In addition to the explicit definition of performance tests, we also ensure that
### File Structure ### 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| |File Path|Description|
|:-:|-| |:-:|-|
@ -236,7 +236,7 @@ Current list of test tags:
### Continuous Integration ### 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) 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. 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. So for every commit, Playwright is effectively running 4 x 2 concurrent browsercontexts to keep the overall runtime to a miminum.

View File

@ -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 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', testDir: 'tests',
grepInvert: /@mobile/, //Ignore mobile 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, timeout: 60 * 1000,
webServer: { webServer: {
command: 'npm run start:coverage', command: 'npm run start:coverage',

View File

@ -10,7 +10,7 @@ import { fileURLToPath } from 'url';
const config = { 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 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', 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, timeout: 30 * 1000,
webServer: { webServer: {
command: 'npm run start:coverage', command: 'npm run start:coverage',

View File

@ -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 * 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! * 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. * 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 }) => { test('An existing Timer object can be renamed via the 3dot actions menu', async ({ page }) => {
const newObjectName = 'Renamed Timer'; 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); await renameTimerFrom3DotMenu(page, timer.url, newObjectName);
// Assert that the name has changed in the browser bar to the value we assigned above // Assert that the name has changed in the browser bar to the value we assigned above

View File

@ -22,7 +22,7 @@ class Dialog extends Overlay {
super({ super({
element: vNode.el, element: vNode.el,
size: 'fit', size: 'fit',
dismissable: false, dismissible: false,
...options ...options
}); });

View File

@ -15,7 +15,7 @@ class Overlay extends EventEmitter {
constructor({ constructor({
buttons, buttons,
autoHide = true, autoHide = true,
dismissable = true, dismissible = true,
element, element,
onDestroy, onDestroy,
onDismiss, onDismiss,
@ -27,7 +27,7 @@ class Overlay extends EventEmitter {
this.container.classList.add('l-overlay-wrapper', cssClasses[size]); this.container.classList.add('l-overlay-wrapper', cssClasses[size]);
this.autoHide = autoHide; this.autoHide = autoHide;
this.dismissable = dismissable !== false; this.dismissible = dismissible !== false;
const { destroy } = mount( const { destroy } = mount(
{ {
@ -38,7 +38,7 @@ class Overlay extends EventEmitter {
dismiss: this.notifyAndDismiss.bind(this), dismiss: this.notifyAndDismiss.bind(this),
element, element,
buttons, buttons,
dismissable: this.dismissable dismissible: this.dismissible
}, },
template: '<overlay-component></overlay-component>' template: '<overlay-component></overlay-component>'
}, },

View File

@ -76,7 +76,7 @@ class OverlayAPI {
*/ */
dismissLastOverlay() { dismissLastOverlay() {
let lastOverlay = this.activeOverlays[this.activeOverlays.length - 1]; let lastOverlay = this.activeOverlays[this.activeOverlays.length - 1];
if (lastOverlay && lastOverlay.dismissable) { if (lastOverlay && lastOverlay.dismissible) {
lastOverlay.notifyAndDismiss(); lastOverlay.notifyAndDismiss();
} }
} }
@ -89,7 +89,7 @@ class OverlayAPI {
* @property {'large'|'small'|'fit'} size The preferred size of the overlay. * @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 {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 {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. * @param {OverlayOptions} options - The configuration options for the overlay.
* @returns {Overlay} An instance of the Overlay class. * @returns {Overlay} An instance of the Overlay class.

View File

@ -40,7 +40,7 @@ class ProgressDialog extends Overlay {
super({ super({
element: vNode.el, element: vNode.el,
size: 'fit', size: 'fit',
dismissable: false, dismissible: false,
...options ...options
}); });

View File

@ -55,7 +55,7 @@ class Selection extends Overlay {
super({ super({
element: component.$el, element: component.$el,
size: 'fit', size: 'fit',
dismissable: false, dismissible: false,
onChange, onChange,
currentSelection, currentSelection,
...options ...options

View File

@ -24,7 +24,7 @@
<div class="c-overlay__blocker" @click="destroy"></div> <div class="c-overlay__blocker" @click="destroy"></div>
<div class="c-overlay__outer"> <div class="c-overlay__outer">
<button <button
v-if="dismissable" v-if="dismissible"
aria-label="Close" aria-label="Close"
class="c-click-icon c-overlay__close-button icon-x" class="c-click-icon c-overlay__close-button icon-x"
@click.stop="destroy" @click.stop="destroy"
@ -56,7 +56,7 @@
<script> <script>
export default { export default {
inject: ['dismiss', 'element', 'buttons', 'dismissable'], inject: ['dismiss', 'element', 'buttons', 'dismissible'],
emits: ['destroy'], emits: ['destroy'],
data() { data() {
return { return {
@ -73,7 +73,7 @@ export default {
}, },
methods: { methods: {
destroy() { destroy() {
if (this.dismissable) { if (this.dismissible) {
this.dismiss(); this.dismiss();
} }
}, },

View File

@ -1033,14 +1033,14 @@ export default class TelemetryAPI {
*/ */
/** /**
* Provides telemetry staleness data. To subscribe to telemetry stalenes, * Provides telemetry staleness data. To subscribe to telemetry staleness,
* new StalenessProvider implementations should be * new StalenessProvider implementations should be
* [registered]{@link module:openmct.TelemetryAPI#addProvider}. * [registered]{@link module:openmct.TelemetryAPI#addProvider}.
* *
* @interface StalenessProvider * @interface StalenessProvider
* @property {function} supportsStaleness receieves a domainObject and * @property {function} supportsStaleness receives a domainObject and
* returns a boolean to indicate it will provide staleness * returns a boolean to indicate it will provide staleness
* @property {function} subscribeToStaleness receieves a domainObject to * @property {function} subscribeToStaleness receives a domainObject to
* be subscribed to and a callback to invoke with a StalenessResponseObject * be subscribed to and a callback to invoke with a StalenessResponseObject
* @property {function} isStale an asynchronous method called with a domainObject * @property {function} isStale an asynchronous method called with a domainObject
* and an options object which currently has an abort signal, ex. * and an options object which currently has an abort signal, ex.

View File

@ -47,7 +47,7 @@ describe('Telemetry API', () => {
telemetryAPI = new TelemetryAPI(openmct); telemetryAPI = new TelemetryAPI(openmct);
}); });
describe('telemetry providers', () => { describe('Telemetry providers', () => {
let telemetryProvider; let telemetryProvider;
let domainObject; let domainObject;
@ -706,7 +706,7 @@ describe('Telemetry API', () => {
}); });
}); });
describe('Telemetery', () => { describe('telemetry', () => {
let openmct; let openmct;
let telemetryProvider; let telemetryProvider;
let telemetryAPI; let telemetryAPI;

View File

@ -22,7 +22,7 @@
import { ACTIVE_ROLE_LOCAL_STORAGE_KEY } from './constants.js'; import { ACTIVE_ROLE_LOCAL_STORAGE_KEY } from './constants.js';
class StoragePersistance { class StoragePersistence {
getActiveRole() { getActiveRole() {
return localStorage.getItem(ACTIVE_ROLE_LOCAL_STORAGE_KEY); return localStorage.getItem(ACTIVE_ROLE_LOCAL_STORAGE_KEY);
} }
@ -34,4 +34,4 @@ class StoragePersistance {
} }
} }
export default new StoragePersistance(); export default new StoragePersistence();

View File

@ -24,7 +24,7 @@ import EventEmitter from 'EventEmitter';
import { MULTIPLE_PROVIDER_ERROR, NO_PROVIDER_ERROR } from './constants.js'; import { MULTIPLE_PROVIDER_ERROR, NO_PROVIDER_ERROR } from './constants.js';
import StatusAPI from './StatusAPI.js'; import StatusAPI from './StatusAPI.js';
import StoragePersistance from './StoragePersistance.js'; import StoragePersistence from './StoragePersistence.js';
import User from './User.js'; import User from './User.js';
class UserAPI extends EventEmitter { class UserAPI extends EventEmitter {
@ -115,7 +115,7 @@ class UserAPI extends EventEmitter {
} }
// get from session storage // get from session storage
const sessionStorageValue = StoragePersistance.getActiveRole(); const sessionStorageValue = StoragePersistence.getActiveRole();
return sessionStorageValue; return sessionStorageValue;
} }
@ -126,9 +126,9 @@ class UserAPI extends EventEmitter {
*/ */
setActiveRole(role) { setActiveRole(role) {
if (!role) { if (!role) {
StoragePersistance.clearActiveRole(); StoragePersistence.clearActiveRole();
} else { } else {
StoragePersistance.setActiveRole(role); StoragePersistence.setActiveRole(role);
} }
this.emit('roleChanged', role); this.emit('roleChanged', role);
} }

View File

@ -31,7 +31,7 @@ export default function () {
openmct.overlays.overlay({ openmct.overlays.overlay({
element: vNode.el, element: vNode.el,
size: 'fullscreen', size: 'fullscreen',
dismissable: false, dismissible: false,
onDestroy: destroy onDestroy: destroy
}); });
}); });

View File

@ -216,7 +216,7 @@ export default {
const annotateOverlay = this.openmct.overlays.overlay({ const annotateOverlay = this.openmct.overlays.overlay({
element: vNode.el, element: vNode.el,
size: 'large', size: 'large',
dismissable: false, dismissible: false,
buttons: [ buttons: [
{ {
label: 'Cancel', label: 'Cancel',
@ -371,7 +371,7 @@ export default {
onDestroy: destroy, onDestroy: destroy,
size: 'large', size: 'large',
autoHide: false, autoHide: false,
dismissable: true, dismissible: true,
buttons: [ buttons: [
{ {
label: 'Done', label: 'Done',

View File

@ -65,7 +65,7 @@ export default {
this.overlay = this.openmct.overlays.overlay({ this.overlay = this.openmct.overlays.overlay({
element: this.$el, element: this.$el,
size: 'large', size: 'large',
dismissable: true, dismissible: true,
buttons: [ buttons: [
{ {
label: 'Clear All Notifications', label: 'Clear All Notifications',

View File

@ -247,7 +247,7 @@ export default function ConditionEvaluator(subscriptionCache, compositionObjs) {
* Evaluate the conditions passed in as an argument, and return the boolean * Evaluate the conditions passed in as an argument, and return the boolean
* value of these conditions. Available evaluation modes are 'any', which will * value of these conditions. Available evaluation modes are 'any', which will
* return true if any of the conditions evaluates to true (i.e. logical OR); 'all', * return true if any of the conditions evaluates to true (i.e. logical OR); 'all',
* which returns true only if all conditions evalute to true (i.e. logical AND); * which returns true only if all conditions evaluate to true (i.e. logical AND);
* or 'js', which returns the boolean value of a custom JavaScript conditional. * or 'js', which returns the boolean value of a custom JavaScript conditional.
* @param {} conditions Either an array of objects with object, key, operation, * @param {} conditions Either an array of objects with object, key, operation,
* and value fields, or a string representing a JavaScript * and value fields, or a string representing a JavaScript

View File

@ -58,7 +58,7 @@ class ViewDatumAction {
this.openmct.overlays.overlay({ this.openmct.overlays.overlay({
element: vNode.el, element: vNode.el,
size: 'large', size: 'large',
dismissable: true, dismissible: true,
onDestroy: destroy onDestroy: destroy
}); });
} }