@naturalcycles/dev-lib
> Set of opinionated configuration files and tools for common project needs, to be shared between > all modules. Enforces conventions between projects.
Last updated 5 days ago by cervicalmucus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @naturalcycles/dev-lib 
SYNC missed versions from official npm registry.

@naturalcycles/dev-lib

Set of opinionated configuration files and tools for common project needs, to be shared between all modules. Enforces conventions between projects.

npm Maintainability Test Coverage code style: prettier

How to use

Install it:

yarn add -D @naturalcycles/dev-lib

This unlocks all commands listed below, e.g:

yarn test
yarn lint-all

By default it uses default configs for Prettier and TSLint that are included in this package (for convenience). You can override them by putting your own prettier.config.js / tslint.json in root folder of your project.

Conventions

Primary language: TypeScript (*.ts).

All files are linted and prettified upon commit (using husky, lint-staged and prettier).

Folder structure

  • /dist target dir to put compiled files into (*.js and additional files like *.json)
  • /dist-cjs target for CommonJS files
  • /dist-esm target for ES Modules
  • /src for all source files
  • /scripts for all non-production source files / scripts.
  • /src/test for generic test-related files and utilities, integration tests.
  • /src/test/mock
  • /src/test/integration for integration tests (unit tests should be placed next to the file)
  • /src/@linked
  • /src/@types
  • /src/env
  • /coverage
  • /tmp
    • /jest/unit.xml
    • /jest/integration.xml
    • /coverage-integration

Yarn commands

These commands are available to be called as yarn <command>, because they are exposed as npm scripts in node_modules/.bin/.

Build commands

  • tsc-prod: does tsc -p tsconfig.prod.ts

  • tsc-scripts: does tsc -p ./scripts/tsconfig.ts --noEmit (type-checking for ./scripts)

  • build: "Development build". Checks that "everything compiles". Does del ./dist && tsc && tsc-scripts

  • bt: "Build & Test". Does del ./dist && tsc && tsc-scripts && test

  • build-copy: copies additional files into dist folder (e.g *.json)

  • build-prod: "Production build". Does del ./dist && build-copy && tsc-prod

Test commands

All test commands set TZ=UTC. You can override it by providing TZ env variable before running a test command.

  • test: alias for jest. Automatically detects full-icu module presense, adds NODE_ICU_DATA=${fullICUPath} if needed. Automatically adds --silent (and JEST_SILENT env var) if all tests are run. Adds APP_ENV=test env var (for all runs except integration).
  • test-ci: runs test in CI environment, with coverage. Includes fix for "CircleCI out of memory issue"
  • test-integration: runs Jest with jest.integration-test.config.js config. Which will only run tests from ./src/test/integration folder.
  • test-integration-ci
  • test-leaks: runs Jest with --logHeapUsage --detectOpenHandles --detectLeaks (requires weak module to be installed in target project).

For unit tests (yarn test) these setupFilesAfterEnv will be used (if found) in that order:

  • <rootDir>/src/test/setupJest.ts
  • <rootDir>/src/test/setupJest.unit.ts

For integration tests (yarn test-integration) these setupFilesAfterEnv will be used (if found) in that order:

  • <rootDir>/src/test/setupJest.ts
  • <rootDir>/src/test/setupJest.integration.ts

Lint commands

  • lint-all: runs Prettier as we want it: first tslint on needed paths, then prettier on top of it.

    • --commitOnChanges will commit lint-modified changes and push them
    • --failOnChanges will exit with status 1 in the end (will fail the command)
  • tslint-all: runs tslint on needed paths

  • prettier-all: runs just Prettier on needed paths

  • lint-circleci: fails if .circleci/config.yml is invalid (CircleCI CLI must be installed before)

Run commands

All these commands will skip type-checking for speed (ts-node -T). Instead, type-checking is done via tsc-scripts as a part of build

  • tsn: short alias for ts-node with additional parameters: -r tsconfig-paths/register -r dotenv/config
  • tsn-script: like tsn but for running scripts inside ./scripts folder, will use ./scripts/tsconfig.json (file will be auto-generated in not present).

Other commands

  • init-from-dev-lib: copy config files from dev-lib/cfg/init to the project
  • update-from-dev-lib: copy config files from dev-lib/cfg/overwrite to the project
  • generate-build-info: generate buildInfo.json
    • --dir <someDir> will save it to given dir
    • --shell will also generate buildInfo.sh
  • json2env: for specified .json file will create .json.sh file next to it that will "export" all values of json file as environment variables. Will also append $BASH_ENV (if defined) for CircleCI. Example: yarn json2env someFile.json will create someFile.json.sh
    • --prefix will prepend all keys with prefix string, e.g --prefix buildInfo_ will output as buildInfo_key1, buildInfo_key2, etc.
    • --no-save-env-file to skip saving .sh file
    • --no-bash-env to skip adding to $BASH_ENV
    • --no-fail will not throw error on missing input file
    • --silent
    • --debug

Non-extendable config files

These files cannot be extended, so they are instead copied into the target project: first time when seeding the project, later manually by running yarn update-from-dev-lib.

These files are overwritten in target project every time the mentioned command is run. So, be careful! Solution is to either extend them in other way (e.g put more .gitignore files in subfolders), OR PR to this project, if the need is generic.

  • .editorconfig
  • .gitignore
  • .codeclimate.yml (with some work it can be made extendable later)

Extendable config files

These files are meant to be extended in target project, so act as recommended defaults.

  • husky.config.js
  • lint-staged.config.js
  • prettier.config.js
  • tslint.json
  • jest.config.js

Dependencies

@naturalcycles/dev-lib is supposed to be included as devDependency.

It has dependencies that will be installed to all modules.

ONLY the dependencies that are:

  • stable
  • safe to automatically update according to semver (e.g ^1.0.0)

are included.

Examples of what devDeps cannot be included:

  • jest

Deps that are listed here are blessed and battle-tested.

Current Tags

  • 8.7.0                                ...           latest (5 days ago)

37 Versions

  • 8.7.0                                ...           5 days ago
  • 8.6.0                                ...           7 days ago
  • 8.5.0                                ...           18 days ago
  • 8.4.0                                ...           23 days ago
  • 8.3.0                                ...           a month ago
  • 8.2.0                                ...           a month ago
  • 8.1.0                                ...           a month ago
  • 8.0.0                                ...           a month ago
  • 7.18.0                                ...           a month ago
  • 7.17.0                                ...           2 months ago
  • 7.16.3                                ...           2 months ago
  • 7.16.2                                ...           2 months ago
  • 7.16.1                                ...           2 months ago
  • 7.16.0                                ...           2 months ago
  • 7.15.1                                ...           3 months ago
  • 7.15.0                                ...           3 months ago
  • 7.14.1                                ...           3 months ago
  • 7.14.0                                ...           3 months ago
  • 7.13.0                                ...           4 months ago
  • 7.12.0                                ...           5 months ago
  • 7.11.1                                ...           5 months ago
  • 7.11.0                                ...           5 months ago
  • 7.10.0                                ...           5 months ago
  • 7.9.0                                ...           5 months ago
  • 7.8.0                                ...           5 months ago
  • 7.7.0                                ...           5 months ago
  • 7.6.0                                ...           5 months ago
  • 7.5.0                                ...           5 months ago
  • 7.4.0                                ...           5 months ago
  • 7.3.1                                ...           6 months ago
  • 7.3.0                                ...           6 months ago
  • 7.2.0                                ...           6 months ago
  • 7.1.0                                ...           6 months ago
  • 7.0.1                                ...           6 months ago
  • 7.0.0                                ...           6 months ago
  • 6.1.0                                ...           6 months ago
  • 6.0.0                                ...           6 months ago
Downloads
Today 0
This Week 0
This Month 50
Last Day 0
Last Week 38
Last Month 149
Dependencies (27)
Dev Dependencies (4)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |