@marvinroger/fusee
This module provides tooling to lint, format, test and write JS modules.
Last updated 2 months ago by marvinroger .
GPL-3.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @marvinroger/fusee 
SYNC missed versions from official npm registry.

Fusee Logo
@marvinroger/fusee

version

This module provides tooling to lint, format, test and write JS modules.


It makes use of the following stack:

Install

yarn global add @marvinroger/fusee

Then, inside a blank Node.js project, run fusee init. This will install the stack, and add the correct scripts inside the package.json.

Installed scripts

yarn lint [files...]

Lint the code with ESlint and Prettier, trying to fix what's fixable. This runs eslint --fix and prettier --write on:

  • src/**/*.ts if not a monorepo
  • packages/**/src/**/*.ts if monorepo
  • Only given files if a list of files is supplied (this is how lint-staged is setup)

The ESLint config can be found at ⚙ src/configs/eslint.ts, and the Prettier config at ⚙ src/configs/prettier.ts.


yarn test

Test the code with Jest. This runs jest --passWithNoTests with the default Jest config, with TS supported and with the /pkg/ path excluded.

The Jest config can be found at ⚙ src/configs/jest.ts.


yarn generate-docs

Generate the HTML docs from the TypeScript code, into the docs/ directory.

Note: Due to a TypeDoc restriction, every single exported method will be documented (even if not exported from the entry-point). To ignore such methods, add a @hidden annotation.


yarn commit

Commit with a Conventional Commits compatible format.


yarn release

Bump package.json according to the commits, update CHANGELOG.md and tag a new release.

Installed Git hooks

The Husky config can be found at ⚙ src/configs/husky.ts. The following hooks are set:

  • pre-commit: This runs lint-staged with the config at ⚙ src/configs/lint-staged.ts. Whenever a file matches the *.{ts,tsx,js,jsx} pattern, the lint script will be ran on these files, fixing what's fixable. If the lint is unsuccessful and it cannot be auto-fixed, the commit will be aborted.

  • commit-msg: This runs commitlint, checking the message against the Conventional Commits format. If it fails, the commit is aborted.

There is no pre-push hook, as it might take too long to build or test the project. These checks should be done on the CI.

Current Tags

  • 4.0.0-beta.0                                ...           beta (3 months ago)
  • 3.3.9                                ...           latest (2 months ago)

23 Versions

  • 3.3.9                                ...           2 months ago
  • 4.0.0-beta.0                                ...           3 months ago
  • 3.3.8                                ...           3 months ago
  • 3.3.7                                ...           7 months ago
  • 3.3.6                                ...           7 months ago
  • 3.3.5                                ...           8 months ago
  • 3.3.4                                ...           8 months ago
  • 3.3.3                                ...           8 months ago
  • 3.3.2                                ...           8 months ago
  • 3.3.1                                ...           8 months ago
  • 3.3.0                                ...           9 months ago
  • 3.2.2                                ...           10 months ago
  • 3.2.1                                ...           10 months ago
  • 3.1.3                                ...           10 months ago
  • 3.1.2                                ...           10 months ago
  • 3.1.1                                ...           10 months ago
  • 3.1.0                                ...           10 months ago
  • 3.0.2                                ...           a year ago
  • 3.0.1                                ...           a year ago
  • 2.2.1                                ...           a year ago
  • 2.2.0                                ...           a year ago
  • 2.0.1                                ...           a year ago
  • 2.0.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dev Dependencies (4)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |