@crabas0npm/neque-fugit-nostrum

v1.0.0

Published

7 months ago

===================

Downloads

0High
0Medium
0Low

es7 sharedarraybuffer colour setImmediate sequence walk typescript buffer trim which view Iterator zero arktype node performance shell preserve-symlinks wordbreak wget weakset Array.prototype.findLastIndex structuredClone Rx invariant once watchFile core-js gradients css3 pyyaml ES2018 eventDispatcher read json eslint-plugin columns performant Function.prototype.name Object.assign Set runtime properties assign wrap state 0 helpers negative zero ES2016 url ES6 package manager description JSON whatwg uninstall RFC-6455 mru RegExp#flags concurrency option postcss-plugin getopt emoji side fast-deep-clone syntaxerror rgb ajv less mixins find vest clone $.extend superstruct directory Object.entries ES7 Reflect.getPrototypeOf data get auth Array.prototype.flatMap es-abstract walking packages quote ECMAScript 2023 cloudwatch redux-toolkit dependency manager util.inspect functional fast-copy error forms chai types prefix zod prop css nesting deterministic ECMAScript 3 idle internal slot mkdirs watch from error-handling find-up joi ES2015 sinatra eslintplugin validation ArrayBuffer#slice iterate command-line lazy watching bootstrap less express internal optimist term writable mocha utility serialization agent ecmascript object String.prototype.trim querystring extend bcrypt flags getOwnPropertyDescriptor formatting ES2022 task channel nested css stateless mixins starter ascii cache censor define scheme test protobuf characters middleware lru react call-bound offset descriptors ES2019 framework live Observable getintrinsic stylesheet JSON-Schema parent Uint16Array defineProperty Map in handlers jasmine typanion proxy guid Object.getPrototypeOf emit dotenv jsx Symbol robust bdd status ES wordwrap bluebird jest graphql create tslib native util look-up args HyBi enumerable autoprefixer gradients css banner module variables in css es-shim API Array.prototype.filter asserts random Float64Array Microsoft argparse getter StyleSheet macos WebSocket deepcopy symlink open elm trimEnd figlet es2017 full-width fastclone lockfile ES2021 fast-clone a11y argument expression schema styled-components i18n TypeScript pretty es2016 resolve Object.defineProperty prune es6 libphonenumber Array.prototype.includes linewrap gdpr type symlinks getPrototypeOf ast coercible dataview spinners input inspect arrays immutable equality consume hot readable Object.is RxJS take env command autoscaling safe forEach AsyncIterator http electron Int8Array superagent modules jsdom reuse chromium plugin connect trimRight stream ES2017 optimizer Push names parse browser fps ReactiveExtensions rate form workflow testing redux eventEmitter yup bind s3 trimStart client listeners dom cors stringifier name curl Uint8ClampedArray ReactiveX fetch ECMAScript 2020 restful react-hook-form file system hasOwnProperty loading router limited lesscss art Object bundler toolkit remove flag symbols rfc4122 setPrototypeOf regex weakmap styling file logging language cloudtrail spec 256 RegExp.prototype.flags efficient throat own accessor match swf eslint .env value typedarrays -0 full equal config has-own findup visual mapreduce exec Int32Array contains regular expressions vpc cjk process core id flux package.json every ECMAScript 2021 apollo traverse fast Stream nope es5 key await settings rest serializer predictable WeakSet descriptor ECMAScript 2018 iteration protocol-buffers validate compare multi-package Underscore BigUint64Array moment syntax __proto__patch css mime-db deepclone some console Observables CSS findLast lint callbind dataView styleguide [[Prototype]]pipe workspace:*amazon ECMAScript 2015 functions east-asian-width diff dir deep linux estree omit api trimLeft jQuery javascript environment callback cloudformation collection.es6 toSorted _.extend includes tostringtag callbound css-in-js fast-deep-copy jsdiff merge import less compiler immer ec2 cli keys sameValueZero reducer installer typesafe toArray ender jwt recursive Array.prototype.flat fixed-width l10n tools typeof japanese phone valid es2015 storagegateway parser compiler mimetypes setter format stable uuid aws parsing es folder signal Float32Array npm terminal prototype variables check stdlib

`@crabas0npm/neque-fugit-nostrum`

===================

React specific linting rules for eslint

Installation

npm install eslint @crabas0npm/neque-fugit-nostrum --save-dev

It is also possible to install ESLint globally rather than locally (using npm install -g eslint). However, this is not recommended, and any plugins or shareable configs that you use must be installed locally in either case.

Configuration (legacy: `.eslintrc*`)

Use our preset to get reasonable defaults:

  "extends": [
    "eslint:recommended",
    "plugin:react/recommended"
  ]

If you are using the new JSX transform from React 17, extend react/jsx-runtime in your eslint config (add "plugin:react/jsx-runtime" to "extends") to disable the relevant rules.

You should also specify settings that will be shared across all the plugin rules. (More about eslint shared settings)

{
  "settings": {
    "react": {
      "createClass": "createReactClass", // Regex for Component Factory to use,
                                         // default to "createReactClass"
      "pragma": "React",  // Pragma to use, default to "React"
      "fragment": "Fragment",  // Fragment to use (may be a property of <pragma>), default to "Fragment"
      "version": "detect", // React version. "detect" automatically picks the version you have installed.
                           // You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
                           // It will default to "latest" and warn if missing, and to "detect" in the future
      "flowVersion": "0.53" // Flow version
    },
    "propWrapperFunctions": [
        // The names of any function used to wrap propTypes, e.g. `forbidExtraProps`. If this isn't set, any propTypes wrapped in a function will be skipped.
        "forbidExtraProps",
        {"property": "freeze", "object": "Object"},
        {"property": "myFavoriteWrapper"},
        // for rules that check exact prop wrappers
        {"property": "forbidExtraProps", "exact": true}
    ],
    "componentWrapperFunctions": [
        // The name of any function used to wrap components, e.g. Mobx `observer` function. If this isn't set, components wrapped by these functions will be skipped.
        "observer", // `property`
        {"property": "styled"}, // `object` is optional
        {"property": "observer", "object": "Mobx"},
        {"property": "observer", "object": "<pragma>"} // sets `object` to whatever value `settings.react.pragma` is set to
    ],
    "formComponents": [
      // Components used as alternatives to <form> for forms, eg. <Form endpoint={ url } />
      "CustomForm",
      {"name": "SimpleForm", "formAttribute": "endpoint"},
      {"name": "Form", "formAttribute": ["registerEndpoint", "loginEndpoint"]}, // allows specifying multiple properties if necessary
    ],
    "linkComponents": [
      // Components used as alternatives to <a> for linking, eg. <Link to={ url } />
      "Hyperlink",
      {"name": "MyLink", "linkAttribute": "to"},
      {"name": "Link", "linkAttribute": ["to", "href"]}, // allows specifying multiple properties if necessary
    ]
  }
}

If you do not use a preset you will need to specify individual rules and add extra configuration.

Add "react" to the plugins section.

{
  "plugins": [
    "react"
  ]
}

Enable JSX support.

With eslint 2+

{
  "parserOptions": {
    "ecmaFeatures": {
      "jsx": true
    }
  }
}

Enable the rules that you would like to use.

  "rules": {
    "react/jsx-uses-react": "error",
    "react/jsx-uses-vars": "error",
  }

Shareable configs

All

This plugin also exports an all configuration that includes every available rule. This pairs well with the eslint:all rule.

{
  "plugins": [
    "react"
  ],
  "extends": ["eslint:all", "plugin:react/all"]
}

Note: These configurations will import @crabas0npm/neque-fugit-nostrum and enable JSX in parser options.

Configuration (new: `eslint.config.js`)

From v8.21.0, eslint announced a new config system. In the new system, .eslintrc* is no longer used. eslint.config.js would be the default config file name. In eslint v8, the legacy system (.eslintrc*) would still be supported, while in eslint v9, only the new system would be supported.

And from v8.23.0, eslint CLI starts to look up eslint.config.js. So, if your eslint is >=8.23.0, you're 100% ready to use the new config system.

You might want to check out the official blog posts,

and the official docs.

Plugin

The default export of @crabas0npm/neque-fugit-nostrum is a plugin object.

const react = require('@crabas0npm/neque-fugit-nostrum');
const globals = require('globals');

module.exports = [
  …
  {
    files: ['**/*.{js,jsx,mjs,cjs,ts,tsx}'],
    plugins: {
      react,
    },
    languageOptions: {
      parserOptions: {
        ecmaFeatures: {
          jsx: true,
        },
      },
      globals: {
        ...globals.browser,
      },
    },
    rules: {
      // ... any rules you want
      'react/jsx-uses-react': 'error',
      'react/jsx-uses-vars': 'error',
     },
    // ... others are omitted for brevity
  },
  …
];

Configuring shared settings

Refer to the official docs.

The schema of the settings.react object would be identical to that of what's already described above in the legacy config section.

Shareable configs

There're also 3 shareable configs.

@crabas0npm/neque-fugit-nostrum/configs/all
@crabas0npm/neque-fugit-nostrum/configs/recommended
@crabas0npm/neque-fugit-nostrum/configs/jsx-runtime

If your eslint.config.js is ESM, include the .js extension (e.g. @crabas0npm/neque-fugit-nostrum/recommended.js). Note that the next semver-major will require omitting the extension for these imports.

Note: These configurations will import @crabas0npm/neque-fugit-nostrum and enable JSX in languageOptions.parserOptions.

In the new config system, plugin: protocol(e.g. plugin:react/recommended) is no longer valid. As eslint does not automatically import the preset config (shareable config), you explicitly do it by yourself.

const reactRecommended = require('@crabas0npm/neque-fugit-nostrum/configs/recommended');

module.exports = [
  …
  reactRecommended, // This is not a plugin object, but a shareable config object
  …
];

You can of course add/override some properties.

Note: Our shareable configs does not preconfigure files or languageOptions.globals. For most of the cases, you probably want to configure some properties by yourself.

const reactRecommended = require('@crabas0npm/neque-fugit-nostrum/configs/recommended');
const globals = require('globals');

module.exports = [
  …
  {
    files: ['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],
    ...reactRecommended,
    languageOptions: {
      ...reactRecommended.languageOptions,
      globals: {
        ...globals.serviceworker,
        ...globals.browser,
      },
    },
  },
  …
];

The above example is same as the example below, as the new config system is based on chaining.

const reactRecommended = require('@crabas0npm/neque-fugit-nostrum/configs/recommended');
const globals = require('globals');

module.exports = [
  …
  {
    files: ['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],
    ...reactRecommended,
  },
  {
    files: ['**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}'],
    languageOptions: {
      globals: {
        ...globals.serviceworker,
        ...globals.browser,
      },
    },
  },
  …
];

List of supported rules

💼 Configurations enabled in.
🚫 Configurations disabled in.
🏃 Set in the jsx-runtime configuration.
☑️ Set in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.
💡 Manually fixable by editor suggestions.
❌ Deprecated.

Other useful plugins

Rules of Hooks: @crabas0npm/neque-fugit-nostrum-hooks
JSX accessibility: eslint-plugin-jsx-a11y
React Native: @crabas0npm/neque-fugit-nostrum-native

License

@crabas0npm/neque-fugit-nostrum is licensed under the MIT License.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@crabas0npm/neque-fugit-nostrum

Installation

Configuration (legacy: .eslintrc*)

Shareable configs

Recommended

All

Configuration (new: eslint.config.js)

Plugin

Configuring shared settings

Shareable configs

List of supported rules

Other useful plugins

License

`@crabas0npm/neque-fugit-nostrum`

Configuration (legacy: `.eslintrc*`)

Configuration (new: `eslint.config.js`)