We use several linters and type checkers for various reasons. The different linters and tools are explained in this document. This should allows us to eliminate the need for Angular wrappers.
- Actions The GitHub actions on your PR will report errors which will be verifiable on the command line running
npm run lint && npm run test
We are using a package called remark
We validate the files by running npm run lint or npm run mdlint. This covers some common mistakes in the .md files we document. The rules can be set in the .remarkrc file.
We are using the core eslinter for Javascript all settings can be set within the .eslintrc.js file in the root. If using Atom the package linter-eslint should be installed. If using visual code the eslint should be installed. The web pack config in the demo app will also report errors in the Google Chrome console while testing.
We are using style lint for checking the rules in scss files. All settings can be set within the .stylelintignore file in the root. If using Atom the package linter-stylelint should be installed. If using visual code the stylelint should be installed. The web pack config in the demo app will also report errors in the Google Chrome console while testing.
We are using HtmlHint lint for checking simple rules around valid HTML. All settings can be set within the .htmlhintrc file in the root. If using Atom the package linter-htmlhint should be installed. If using Visual Code the HTMLHint should be used.
We are using the typescript tsc command for checking simple rules around Typescript and typings. All settings regarding typing can be set within the tsconfig.json file in the root of this project.
If using the Atom editor the package atom-typescript should be installed to see errors in the editor. Within the atom-typescript plugin make sure to check the "Enable Atom-Typescript for JavaScript Files" to see errors in Atom.
In addition we had to disabled a couple warnings it complains about regarding our import statements (in Atom only). To set this in the atom-typescript plugin go to the setting "Ignore Diagnostics" add the following: 6138, 6133.
Occasionally due to a bug in Atom not showing errors when a JS file is open. Click JavaScript on the bottom footer and set it to TypesScript to toggle the visibility of type errors.
The the d.ts will be generated and will give the external facing types. Have a look at jsdoc-supported-types.