This package includes scripts and configuration files used by datavisyn repositories. Collecting everything in a single installable repository unifies configurations across many repositories, thus reducing the maintenance overhead.
Install visyn_scripts via npm: npm i --save-dev git+ssh://[email protected]/datavisyn/visyn_scripts.git#develop
Add visyn_scripts to your package.json scripts, i.e. add "compile": "visyn_scripts compile"
and execute it with npm run compile
, or alternatively directly execute it with npx visyn_scripts compile
.
The main purpose of visyn_scripts are the unified scripts:
Builds a workspace using webpack.
Builds a repository using typescript.
Copies assets, styles, and static files to the dist folder.
Generates docs of a repository using typedoc.
Lints a repository using ESLint.
Tests a repository using Jest.
visyn_scripts also includes default configurations for ESLint, Prettier, Typescript, ...
To integrate them in an existing repository, simply switch to .js
configurations and reexport the configurations found in visyn_scripts. This way, any editor will look for a .prettierrc.js
in the repository, and will find one exporting the common configuration.
module.exports = require('visyn_scripts/config/prettierrc.template');
...
This repository is part of the Target Discovery Platform (TDP). For tutorials, API docs, and more information about the build and deployment process, see the documentation page.