Skip to content

Project structure

Sascha Klatt edited this page Mar 21, 2021 · 1 revision
  • .github/: GitHub stuff
  • coverage/: Generated folder containing the test converage results
  • dist/: Generated folder containing the code published to npm
  • docs/: Contains the documentation
  • docs/tutorials: Contains the tutorials documentation
  • docs/typedoc: Contains the generated typedoc documentation for all versions (jsdoc for older versions)
  • node_modules: The dependencies of this project
  • src: The actual source code
  • stats: Generated folder containing build metrics about the library
  • test: Jest unit tests
  • .eslintignore: Defines files and directories not be linted
  • .eslintrc: Defines lint rules
  • .gitignore: Defines files and directories that should be excluded from git
  • jest.config.js: Jest configuration file
  • LICENSE: The license
  • package.json: The package.json
  • pagesconfig.json: Configures the tutorial pages added to typedoc (used by the typedoc-plugin-pages plugin)
  • README.md: The readme file
  • rollup.config.js: The rollup configuration used to build the library
  • tsconfig.declarations.json: The typescript configuration that is used to generate the Typescript declaration files
  • tsconfig.json: The typescript configuration that is used to transpile Typescript source code to Javascript
  • typedoc.json: The typedoc configuration
  • _yarn-error.log: Yarn error log
  • _yarn.lock: Yarn lock file
Clone this wiki locally