Skip to content
A collection of scripts for JavaScript development
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
src
.gitignore
CHANGELOG.md
LICENSE
README.md
package.json
yarn.lock

README.md

@culturehq/scripts

Package Version

CultureHQ's CLI toolbox for JavaScript projects.

Usage

You install this module as a dev dependency in your package, as in:

yarn add --dev @culturehq/scripts

From there you can invoke any of the scripts listed in src/scripts by running chq-scripts [script]. You can add these to your package.json by adding to the scripts key, as in:

{
  "scripts": {
    "lint": "chq-scripts lint",
    "test": "chq-scripts test"
  }
}

The scripts themselves are listed below:

lint

Runs eslint with the @culturehq/eslint-config base configuration.

If you want to override the configuration, you can do all of the normal eslint config patterns of either creating a .eslintrc file, a .eslintrc.js file, putting a eslintConfig prop in your package.json, or passing the --config flag on the command line.

To make sure you're extending the config for this project, make sure you add extends: ["@culturehq"] to your config.

test

Runs jest with a pre-built configuration from src/config/jestConfig.js.

If you need to do something special at the beginning of the tests (e.g., setting up react-modal), chq-scripts supports adding a setupTests.js file at the root of the repository.

If you're using react-testing-library, chq-scripts will automatically require the cleanup-after-each hook so that you don't have to.

Development

Ensure you have node and yarn installed on your system. Then run yarn in the root of the repository to install the dependencies. Tests are run with yarn test and linting is run with yarn lint.

You can’t perform that action at this time.