mirror of
https://github.com/nasa/openmct.git
synced 2024-12-18 12:56:25 +00:00
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:
parent
393da7dc62
commit
291c0997a6
17
.cspell.json
17
.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",
|
||||
|
8
API.md
8
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()},
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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',
|
||||
|
@ -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',
|
||||
|
@ -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
|
||||
|
@ -22,7 +22,7 @@ class Dialog extends Overlay {
|
||||
super({
|
||||
element: vNode.el,
|
||||
size: 'fit',
|
||||
dismissable: false,
|
||||
dismissible: false,
|
||||
...options
|
||||
});
|
||||
|
||||
|
@ -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: '<overlay-component></overlay-component>'
|
||||
},
|
||||
|
@ -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.
|
||||
|
@ -40,7 +40,7 @@ class ProgressDialog extends Overlay {
|
||||
super({
|
||||
element: vNode.el,
|
||||
size: 'fit',
|
||||
dismissable: false,
|
||||
dismissible: false,
|
||||
...options
|
||||
});
|
||||
|
||||
|
@ -55,7 +55,7 @@ class Selection extends Overlay {
|
||||
super({
|
||||
element: component.$el,
|
||||
size: 'fit',
|
||||
dismissable: false,
|
||||
dismissible: false,
|
||||
onChange,
|
||||
currentSelection,
|
||||
...options
|
||||
|
@ -24,7 +24,7 @@
|
||||
<div class="c-overlay__blocker" @click="destroy"></div>
|
||||
<div class="c-overlay__outer">
|
||||
<button
|
||||
v-if="dismissable"
|
||||
v-if="dismissible"
|
||||
aria-label="Close"
|
||||
class="c-click-icon c-overlay__close-button icon-x"
|
||||
@click.stop="destroy"
|
||||
@ -56,7 +56,7 @@
|
||||
|
||||
<script>
|
||||
export default {
|
||||
inject: ['dismiss', 'element', 'buttons', 'dismissable'],
|
||||
inject: ['dismiss', 'element', 'buttons', 'dismissible'],
|
||||
emits: ['destroy'],
|
||||
data() {
|
||||
return {
|
||||
@ -73,7 +73,7 @@ export default {
|
||||
},
|
||||
methods: {
|
||||
destroy() {
|
||||
if (this.dismissable) {
|
||||
if (this.dismissible) {
|
||||
this.dismiss();
|
||||
}
|
||||
},
|
||||
|
@ -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
|
||||
* [registered]{@link module:openmct.TelemetryAPI#addProvider}.
|
||||
*
|
||||
* @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
|
||||
* @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
|
||||
* @property {function} isStale an asynchronous method called with a domainObject
|
||||
* and an options object which currently has an abort signal, ex.
|
||||
|
@ -47,7 +47,7 @@ describe('Telemetry API', () => {
|
||||
telemetryAPI = new TelemetryAPI(openmct);
|
||||
});
|
||||
|
||||
describe('telemetry providers', () => {
|
||||
describe('Telemetry providers', () => {
|
||||
let telemetryProvider;
|
||||
let domainObject;
|
||||
|
||||
@ -706,7 +706,7 @@ describe('Telemetry API', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('Telemetery', () => {
|
||||
describe('telemetry', () => {
|
||||
let openmct;
|
||||
let telemetryProvider;
|
||||
let telemetryAPI;
|
||||
|
@ -22,7 +22,7 @@
|
||||
|
||||
import { ACTIVE_ROLE_LOCAL_STORAGE_KEY } from './constants.js';
|
||||
|
||||
class StoragePersistance {
|
||||
class StoragePersistence {
|
||||
getActiveRole() {
|
||||
return localStorage.getItem(ACTIVE_ROLE_LOCAL_STORAGE_KEY);
|
||||
}
|
||||
@ -34,4 +34,4 @@ class StoragePersistance {
|
||||
}
|
||||
}
|
||||
|
||||
export default new StoragePersistance();
|
||||
export default new StoragePersistence();
|
@ -24,7 +24,7 @@ import EventEmitter from 'EventEmitter';
|
||||
|
||||
import { MULTIPLE_PROVIDER_ERROR, NO_PROVIDER_ERROR } from './constants.js';
|
||||
import StatusAPI from './StatusAPI.js';
|
||||
import StoragePersistance from './StoragePersistance.js';
|
||||
import StoragePersistence from './StoragePersistence.js';
|
||||
import User from './User.js';
|
||||
|
||||
class UserAPI extends EventEmitter {
|
||||
@ -115,7 +115,7 @@ class UserAPI extends EventEmitter {
|
||||
}
|
||||
|
||||
// get from session storage
|
||||
const sessionStorageValue = StoragePersistance.getActiveRole();
|
||||
const sessionStorageValue = StoragePersistence.getActiveRole();
|
||||
|
||||
return sessionStorageValue;
|
||||
}
|
||||
@ -126,9 +126,9 @@ class UserAPI extends EventEmitter {
|
||||
*/
|
||||
setActiveRole(role) {
|
||||
if (!role) {
|
||||
StoragePersistance.clearActiveRole();
|
||||
StoragePersistence.clearActiveRole();
|
||||
} else {
|
||||
StoragePersistance.setActiveRole(role);
|
||||
StoragePersistence.setActiveRole(role);
|
||||
}
|
||||
this.emit('roleChanged', role);
|
||||
}
|
||||
|
@ -31,7 +31,7 @@ export default function () {
|
||||
openmct.overlays.overlay({
|
||||
element: vNode.el,
|
||||
size: 'fullscreen',
|
||||
dismissable: false,
|
||||
dismissible: false,
|
||||
onDestroy: destroy
|
||||
});
|
||||
});
|
||||
|
@ -216,7 +216,7 @@ export default {
|
||||
const annotateOverlay = this.openmct.overlays.overlay({
|
||||
element: vNode.el,
|
||||
size: 'large',
|
||||
dismissable: false,
|
||||
dismissible: false,
|
||||
buttons: [
|
||||
{
|
||||
label: 'Cancel',
|
||||
@ -371,7 +371,7 @@ export default {
|
||||
onDestroy: destroy,
|
||||
size: 'large',
|
||||
autoHide: false,
|
||||
dismissable: true,
|
||||
dismissible: true,
|
||||
buttons: [
|
||||
{
|
||||
label: 'Done',
|
||||
|
@ -65,7 +65,7 @@ export default {
|
||||
this.overlay = this.openmct.overlays.overlay({
|
||||
element: this.$el,
|
||||
size: 'large',
|
||||
dismissable: true,
|
||||
dismissible: true,
|
||||
buttons: [
|
||||
{
|
||||
label: 'Clear All Notifications',
|
||||
|
@ -247,7 +247,7 @@ export default function ConditionEvaluator(subscriptionCache, compositionObjs) {
|
||||
* Evaluate the conditions passed in as an argument, and return the boolean
|
||||
* 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',
|
||||
* 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.
|
||||
* @param {} conditions Either an array of objects with object, key, operation,
|
||||
* and value fields, or a string representing a JavaScript
|
||||
|
@ -58,7 +58,7 @@ class ViewDatumAction {
|
||||
this.openmct.overlays.overlay({
|
||||
element: vNode.el,
|
||||
size: 'large',
|
||||
dismissable: true,
|
||||
dismissible: true,
|
||||
onDestroy: destroy
|
||||
});
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user