Skip to content
🛠 Various addons related helpers to build CLIs.
TypeScript JavaScript
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.
src Allow to disable autoClose on Xpi (#27) Oct 17, 2019
.eslintrc initial commit Sep 17, 2019
.gitignore initial commit Sep 17, 2019
.npmignore
.npmrc initial commit Sep 17, 2019
.prettierignore initial commit Sep 17, 2019
.prettierrc initial commit Sep 17, 2019
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md s/addons-cli-utils/addons-scanner-utils (#12) Sep 23, 2019
LICENSE.txt initial commit Sep 17, 2019
README.md Update README.md Sep 30, 2019
jest.config.js initial commit Sep 17, 2019
package.json
renovate.json Configure Renovate (#15) Sep 26, 2019
tsconfig.json initial commit Sep 17, 2019
yarn.lock Update typescript-eslint monorepo to v2 (major) (#18) Oct 14, 2019

README.md

addons-scanner-utils

Build Status codecov npm version

Various addons related helpers to build scanners.

Usage

yarn add addons-scanner-utils

Requirements

  • You need Node 10 which is the current LTS (long term support) release.
  • You need yarn to manage dependencies and run commands.

Development

  • Read our contributing guidelines to get started on your first patch
  • Clone this repository
  • Type yarn to install everything
  • Run the test suite to make sure everything is set up: yarn test

Available development commands

In the project directory, you can run the following commands. There are a few commands not mentioned here (see package.json) but those are only used by internal processes.

yarn eslint

This runs ESLint to discover problems within our codebase without executing it. ESLint also enforces some patterns and practices.

yarn lint

This runs all the lint commands at once.

yarn prettier

This runs Prettier to automatically format the entire codebase.

yarn prettier-dev

This runs Prettier on only your changed files. This is intended for development.

yarn test

This launches Jest in the interactive watch mode.

Prettier

We use Prettier to automatically format our JavaScript code and stop all the on-going debates over styles. As a developer, you have to run it (with yarn prettier-dev) before submitting a Pull Request.

Versioning

This project follows the semantic versioning specification.

In order to release a new version, one has to run the npm version command with one of the following arguments: minor, patch or major (less frequent). This command (1) updates the version in package.json, (2) create a new commit for the release and (3) make a git tag.

You can’t perform that action at this time.