Newton's Principia Mathematica

    @byteflowjs/rcpack

    1.0.37 • Public • Published

    RCPack

    This package provides a collection of reasonable default prettier, eslint files for fast-paced JS development. This is especially useful when you need to unify coding style across multiple projects & teams.

    Pre-requisite

    Make sure you have the following VSCode extensions installed:

    • ESLint
    • Prettier

    Option 1: Auto-install

    In your project folder, run:

    ([ ! -e package.json ] && npm init -y); npm i -D @byteflowjs/rcpack && npx rcpack create
    

    This will generate the following files in your project (overwrite existing ones):

    project
    ├── .eslintrc.js --------> Customize rules here
    ├── .prettierrc.js ------> Customize formats here
    ├── .eslintignore
    ├── .prettierignore
    ├── .vscode
    │   └── settings.json
    

    Now, VSCode will format your code on save + show lint issues on the bottom bar. You may need to reload VSCode for the extensions to apply these configs.

    Note, lint issues are shown for all currently opened tabs only. To lint ALL files in the project, in editor:

    • Hit cmd+p
    • Type >run task
    • Choose eslint: lint whole folder

    If for some reason, you want to delete these files...

    npx rcpack delete
    

    Option 2: Manual install

    Install the package as a dev dependency.

    npm i -D @byteflowjs/rcpack
    

    In your .eslintrc.js file, write:

    module.exports = {
      extends: [require.resolve('@byteflowjs/rcpack/eslint')],
      rules: {
        // Your rules here
      },
    };

    In your .prettierrc.js file, write:

    const prettier = require('@byteflowjs/rcpack/prettier');
    
    module.exports = {
      ...prettier,
      // Your rules here
    };

    To achieve format on-save in VSCode. In root directory, create a .vscode folder. Inside, create a settings.json file. Write:

    {
      "editor.defaultFormatter": "esbenp.prettier-vscode",
      "editor.formatOnSave": true,
      "editor.formatOnPaste": false,
      "eslint.lintTask.enable": true
    }

    We need to reload VSCode to so ESLint and Prettier extensions take effect. cmd+shift+p and type reload window.

    Now, on file save, VSCode will automatically format your code and lint errors.

    Format & lint pre-commit

    In examples/package.json, check devDependencies and script section to see an example of how to format code & lint out the errors prior to pushing your code to repository.

    Install

    npm i @byteflowjs/rcpack

    DownloadsWeekly Downloads

    45

    Version

    1.0.37

    License

    MIT

    Unpacked Size

    17.1 kB

    Total Files

    17

    Last publish

    Collaborators

    • byteflowjs