eslint-generate-todo

    0.1.1 • Public • Published

    eslint-generate-todo

    Tool for generating eslint todo files

    Installation

    yarn add --dev eslint-generate-todo

    Usage

    Generate a .eslintrc-todo file using the eslint-generate-todo CLI:

    eslint-generate-todo

    You may then extend the resulting .eslintrc-todo file in your eslint config:

    extends:
      - .eslintrc-todo.yml

    CLI

    Run eslint-generate-todo through the CLI with this script. Run it with --help to see the options. Files use glob syntax and may be specified multiple times.

    eslint-generate-todo [files...]

    --format

    If you want to specify the file format of the output .eslintrc-todo file, you can run eslint-generate-todo with the --format flag (or -f), followed by either yaml or json. By default eslint-generate-todo outputs to yaml.

    eslint-generate-todo --format json

    --off

    To set rule overrides in the generated .eslintrc-todo file to "off" instead of "warn", you can run eslint-generate-todo with the --off (or -o) flag.

    eslint-generate-todo --off

    --path

    To change the output path of the generated .eslintrc-todo file, you can run eslint-generate-todo with the --path (or p) flag, followed by the project root-relative path.

    eslint-generate-todo --path config/eslint-overrides.yml

    Developing

    Please read the CONTRIBUTING doc before working on eslint-generate-todo.

    To build eslint-generate-todo, you can run the build script:

    yarn run build

    While developing, you can run the dev script to automatically rebuild as files change:

    yarn run dev

    To lint code changes, you can run the lint script:

    yarn run lint

    To format code using Prettier, you can run the format script:

    yarn run format

    To run tests with Jest, you can run the test script:

    yarn run test

    License

    The eslint-generate-todo tool is offered under the Apache v2 license.

    Install

    npm i eslint-generate-todo

    DownloadsWeekly Downloads

    1,883

    Version

    0.1.1

    License

    Apache-2.0

    Unpacked Size

    12 kB

    Total Files

    12

    Last publish

    Collaborators

    • markbrouch