@osjwnpm/numquam-voluptas-quisquam

v1.0.0

Published

7 months ago

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

Downloads

0High
0Medium
0Low

async typesafe function make dir URLSearchParams arktype shell map callbound types omit regular promises Stream colors spinners es2016 matches package.json extend prototype setImmediate visual weakset dependencies Underscore getter tostringtag args configurable eslintconfig picomatch Array.prototype.flat es-shim API throttle protobuf modules elasticache Object.keys Object.getPrototypeOf vpc Object.entries clone east-asian-width symlink tdd ArrayBuffer emr airbnb hookform callback live postcss-plugin fast-copy tools chinese hash wrap fullwidth less compiler traverse toStringTag workspace:*array chromium ECMAScript 2019 serialize functional search replay import Object core limit es2018 iteration findLastIndex cloudwatch ec2 monorepo ES2019 preserve-symlinks mkdir own redux-toolkit equality circular Rx JSON typeof setter package manager data fast-deep-copy terminal proxy equal log hooks connect node copy cloudfront es8 Set trimRight bluebird prefix js functions wordwrap ES5 move bootstrap css group framework url cli full assertion Object.assign crypto persistent higher-order look sequence find-up curl from define has pretty https push react-hooks extension rmdir regex browser toArray byteOffset shrinkwrap RFC-6455 0 ava a11y korean iam matchAll utility resolve rate deep check ES2015 rm -rf path ES2021 dependency manager date lru sort mobile jsx logger s3 stable password iterate location style concurrency key descriptor real-time sharedarraybuffer moment ECMAScript 2017 multi-package valid sameValueZero consume CSSStyleDeclaration efficient react-hook-form guid bundling includes type less css rfc4122 term accessibility negative zero authentication react ECMAScript 2022 autoscaling buffer styled-components readable codes walk Array.prototype.contains Streams lint typed array rangeerror minimal es7 Symbol styling warning dataView Reflect.getPrototypeOf symbols directory classnames length create ArrayBuffer.prototype.slice callbind channel less StyleSheet flatMap description apollo install Object.is open forEach fs ratelimit getintrinsic form performant stream fastclone URL watchFile redux read karma swf test

`@osjwnpm/numquam-voluptas-quisquam`

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

React specific linting rules for eslint

Installation

npm install eslint @osjwnpm/numquam-voluptas-quisquam --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 @osjwnpm/numquam-voluptas-quisquam 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 @osjwnpm/numquam-voluptas-quisquam is a plugin object.

const react = require('@osjwnpm/numquam-voluptas-quisquam');
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.

@osjwnpm/numquam-voluptas-quisquam/configs/all
@osjwnpm/numquam-voluptas-quisquam/configs/recommended
@osjwnpm/numquam-voluptas-quisquam/configs/jsx-runtime

If your eslint.config.js is ESM, include the .js extension (e.g. @osjwnpm/numquam-voluptas-quisquam/recommended.js). Note that the next semver-major will require omitting the extension for these imports.

Note: These configurations will import @osjwnpm/numquam-voluptas-quisquam 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('@osjwnpm/numquam-voluptas-quisquam/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('@osjwnpm/numquam-voluptas-quisquam/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('@osjwnpm/numquam-voluptas-quisquam/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: @osjwnpm/numquam-voluptas-quisquam-hooks
JSX accessibility: eslint-plugin-jsx-a11y
React Native: @osjwnpm/numquam-voluptas-quisquam-native

License

@osjwnpm/numquam-voluptas-quisquam is licensed under the MIT License.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@osjwnpm/numquam-voluptas-quisquam

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

`@osjwnpm/numquam-voluptas-quisquam`

Configuration (legacy: `.eslintrc*`)

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