openmct/tsconfig.json

/* Note: Open MCT does not intend to support the entire Typescript ecosystem at this time.
 * This file is intended to add Intellisense for IDEs like VSCode. For more information
 * about Typescript, please discuss in https://github.com/nasa/openmct/discussions/4693
 */
{
  "compilerOptions": {
    "baseUrl": "./",
    "allowJs": true,
    "checkJs": false,
    "declaration": true,
    "emitDeclarationOnly": true,
    "declarationMap": true,
    "strict": true,
    "esModuleInterop": true,
    "noImplicitOverride": true,
    "noImplicitAny": false,
    "outFile": "dist/types/index.d.ts"
  },
  "include": [
    "src/api/**/*.js"
  ],
  "exclude": [
    "node_modules",
    "dist",
    "**/*Spec.js"
  ]
}
Move off node10 and add intellisense (#4643) * Move off node10 and bring in node16 * Update engine lock * update webpack and add the output.hashFunction option to avoid a potential issue with Node 17 in case the config changes closer to defaults At the moment there is no error with Node 17 because the config strays from the defaults and avoids the common case. Also add a tsconfig.json file that enables VS Code and other IDEs to perform type checking on the side. For example now the webpack config file is type checked. This does not impact any existing processes, our build scripts are left untouched and only IDEs will use it for live intellisense and type checking when viewing files (f.e. showing helpful red squiggly underlines on type errors) * mini-css-extract-plugin * Update webpack.prod.js * Update webpack.prod.js * 15 * Update config.yml * Updated config.yml * Updated config.yml * Updated config.yml * Update package.json * comment and EOF Co-authored-by: Joe Pea <joe.pea@nasa.gov> Co-authored-by: Joe Pea <trusktr@gmail.com> Co-authored-by: Andrew Henry <akhenry@gmail.com> 2022-01-07 11:39:25 -08:00			`/* Note: Open MCT does not intend to support the entire Typescript ecosystem at this time.`
			`* This file is intended to add Intellisense for IDEs like VSCode. For more information`
			`* about Typescript, please discuss in https://github.com/nasa/openmct/discussions/4693`
			`*/`
			`{`
			`"compilerOptions": {`
Add baseUrl, outDir, and exclude options (#5757) - Fixes erroneous TS language server warnings showing up in the VSCode terminal - Ensures TypeScript language server features (such as refactor) are able to work properly by excluding build files 2022-09-14 10:05:41 -07:00			`"baseUrl": "./",`
Move off node10 and add intellisense (#4643) * Move off node10 and bring in node16 * Update engine lock * update webpack and add the output.hashFunction option to avoid a potential issue with Node 17 in case the config changes closer to defaults At the moment there is no error with Node 17 because the config strays from the defaults and avoids the common case. Also add a tsconfig.json file that enables VS Code and other IDEs to perform type checking on the side. For example now the webpack config file is type checked. This does not impact any existing processes, our build scripts are left untouched and only IDEs will use it for live intellisense and type checking when viewing files (f.e. showing helpful red squiggly underlines on type errors) * mini-css-extract-plugin * Update webpack.prod.js * Update webpack.prod.js * 15 * Update config.yml * Updated config.yml * Updated config.yml * Updated config.yml * Update package.json * comment and EOF Co-authored-by: Joe Pea <joe.pea@nasa.gov> Co-authored-by: Joe Pea <trusktr@gmail.com> Co-authored-by: Andrew Henry <akhenry@gmail.com> 2022-01-07 11:39:25 -08:00			`"allowJs": true,`
turn off errors from type checking in IDEs by default. Turn it on locally to type check (#4705) Co-authored-by: Joe Pea <joe.pea@nasa.gov> 2022-01-11 11:40:51 -08:00			`"checkJs": false,`
Generate type declarations for CompositionAPI and publish with OpenMCT (#5838) * add typescript * update tsconfig * convert to es6 class * Convert more stuff to es6 class * skip checking libs, test files * more es6 classes! * Fix some jsdocs * Rename file * Improve jsdoc types * Rename references as well * more types * types for CompositionAPI * Types for CompositionCollection * Types for CompositionProvider * type * types for api * nvm * cleanup MCT * Fix API type definition * Generate types before publish * fix openmct 👀 * rename PublicAPI -> OpenMCT and document methods * try and fix visual test ? * Make private methods private * more private methods!! * import all es6 api's so we get more types for free * convert Selection to es6 class * remove redundant docs * fix Branding types * fix openmct.start() types * Remove useless `@memberof` * Add parameter name * [docs] Add a section on Types * markdownlint * word * Add section on limitations / contibuting types * Let these methods be private * make private members private, fix a type * fix another type * Make method private * Update docs for `skipMutate` and related methods * Rename file and fix references * `DefaultCompositionProvider` extends `CompositionProvider` * Make private members private * Type for `AbortSignal` * `domainObject` must be accessible for perf tests Co-authored-by: Andrew Henry <akhenry@gmail.com> 2022-10-21 17:29:52 -07:00			`"declaration": true,`
			`"emitDeclarationOnly": true,`
			`"declarationMap": true,`
Move off node10 and add intellisense (#4643) * Move off node10 and bring in node16 * Update engine lock * update webpack and add the output.hashFunction option to avoid a potential issue with Node 17 in case the config changes closer to defaults At the moment there is no error with Node 17 because the config strays from the defaults and avoids the common case. Also add a tsconfig.json file that enables VS Code and other IDEs to perform type checking on the side. For example now the webpack config file is type checked. This does not impact any existing processes, our build scripts are left untouched and only IDEs will use it for live intellisense and type checking when viewing files (f.e. showing helpful red squiggly underlines on type errors) * mini-css-extract-plugin * Update webpack.prod.js * Update webpack.prod.js * 15 * Update config.yml * Updated config.yml * Updated config.yml * Updated config.yml * Update package.json * comment and EOF Co-authored-by: Joe Pea <joe.pea@nasa.gov> Co-authored-by: Joe Pea <trusktr@gmail.com> Co-authored-by: Andrew Henry <akhenry@gmail.com> 2022-01-07 11:39:25 -08:00			`"strict": true,`
Type annotations (#4789) * add some types to XAxisModel * some more type defs and small code tweaks while getting familiar with plots * more type annotations and a few small tweaks * more type annotations and small tweaks to make types show * add mocha types * Add karma and jasmine, too * further simplify plot canvas creation * further simplify plot canvas creation * update types, avoid runtime behavior in type definition that breaks SeriesCollection * undo the changes to MctChart, improve it later * lint fix Co-authored-by: unlikelyzero <jchill2@gmail.com> Co-authored-by: John Hill <john.c.hill@nasa.gov> Co-authored-by: Jamie V <jamie.j.vigliotta@nasa.gov> 2022-03-29 14:39:49 -07:00			`"esModuleInterop": true,`
			`"noImplicitOverride": true,`
docs: Mission Status and more (#7521) * chore: update tsconfig to target modern ES * docs: update UserProvider * docs: update UserAPI, make openmct private * docs: update StatusAPI * refactor: convert ViewRegistry to ES6 class * docs: finish type imports for openmct api * docs: minor doc improvements * docs: add UserIndicator readme * docs: add User API section to API docs * docs: document Mission Status * docs(JSDoc): primitive types should be lowercase, otherwise TitleCase 2024-03-26 12:11:00 -07:00			`"noImplicitAny": false,`
docs: better docs and types for the API (#7796) * docs: fix type imports in openmct.js * docs: fix type imports * docs: fix types for eventHelpers * docs: types for TypeRegistry * docs: types for StatusAPI * docs: fix ObjectAPI types and docs * docs: more types * docs: improved types for main entry * docs: improved types * fix: unbreak the linting * chore: remove EventEmitter webpack alias as it hide types * fix: return type * fix: parameter type * fix: types for composables * chore: add webpack consts to eslintrc * fix: remove usage of deprecated timeAPI methods and add a ton of docs and types * docs: update README.md * lint: clean up API.md * chore: upgrade eventemitter to v5.0.2 * refactor: update imports for EventEmitter to remove alias * format: lint * docs: update types for Views and ViewProviders * docs: expose common types at the base import level * docs(types): remove unnecessary tsconfig options * docs: ActionAPI * docs: AnnotationAPI * docs: import common types from the same origin * docs: FormsAPI & TelemetryAPI types * docs: FormController, IndicatorAPI * docs: MenuAPI, ActionsAPI * docs: `@memberof` is not supported by `tsc` and JSDoc generation so remove it * docs: RootRegistry and RootObjectProvider * docs: Transaction + Overlay * lint: words for the word god * fix: review comments 2024-07-31 10:46:16 -07:00			`"outFile": "dist/types/index.d.ts"`
Add baseUrl, outDir, and exclude options (#5757) - Fixes erroneous TS language server warnings showing up in the VSCode terminal - Ensures TypeScript language server features (such as refactor) are able to work properly by excluding build files 2022-09-14 10:05:41 -07:00			`},`
chore: remove `type: module`, create `openmct-e2e` subpackage (#7590) * fix: remove mystery webpack code * fix: remove type:module and specify exports - we aren't a module... yet * fix: rename webpack.js to webpack.mjs so we can use import/export. fix imports * fix: exports format * fix: woops, need to add `start` script back * chore: split e2e into its own module * fix: use normal Painterro import * fix: update e2e pathing * fix: copy over helper functions * chore: specify `cwd` for playwright configs so that openmct npm commands work as intended in any environment * chore: add pretest script to e2e package.json * chore: don't package e2e * refactor: tidy up webpack common config * chore: compile types to a single file * chore: fix visual test npm scripts * chore: fix import pathing * chore: define package exports, move test specific dependencies to the subpackage * chore: export test framework from openmct-e2e * chore: export baseFixtures also * chore: let `openmct` and `openmct-e2e` share `node_modules/` * chore: use `--workspace`, remove pretest script * Revert "fix: remove mystery webpack code" This reverts commit eb14d52569ffa27ab1a090b883694f4707b59cd0. * chore: update package-lock * chore: add `.npmignore` * fix: *js -> mjs 2024-03-28 14:49:00 -07:00			`"include": [`
			`"src/api/*/.js"`
			`],`
			`"exclude": [`
			`"node_modules",`
			`"dist",`
			`"*/Spec.js"`
			`]`
			`}`