@a-2-c-2-anpm/atque-doloremque-autem

v1.0.0

Published

6 months ago

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

Downloads

0High
0Medium
0Low

es2018 routing immutable korean ponyfill execfile arraybuffer deep-copy swf npm source map Rx deepcopy write isConcatSpreadable URL ESnext ArrayBuffer curl asterisks invariant log starter collection.es6 string loadbalancing robust internal slot toSorted .gitignore zod every check Array.prototype.flatten http rds progress toArray query expression hookform Array.prototype.filter busy redux serialization vars indicator tslib telephone simpledb weakmap keys util.inspect animation jest configurable ender negative zero gitignore consume link waf manager streams findLastIndex escape rules linewrap side Object.assign rss computed-types format rgb rfc4122 codes ES6 batch ES2020 _.extend gdpr time joi ECMAScript 7 asserts getopt Object.defineProperty mimetypes valid find-up ArrayBuffer#slice Observable values awesomesauce native real-time obj json superagent popmotion shebang RxJS testing ECMAScript 2018 JSON wrap exec TypedArray form util throat functions fs parse concurrency ES2015 properties picomatch stable private iteration ES8 date call-bound once ava some dir data setter express concat emr last emit redirect package symbols internal argument byte callbound zx spec es-shim API shrinkwrap lazy package.json take prune identifiers compare optimist function.length environments client ReactiveExtensions look typescript figlet nope guid performance URLSearchParams RFC-6455 entries route trim typanion ECMAScript 2016 cli queue Int8Array WeakMap @@toStringTag trimEnd autoscaling parsing cloudtrail fetch mkdirp graphql-client iterator arktype trimLeft ignore readablestream browserlist make dir mobile drag colors callback tc39 mime-db aws bluebird callbind 0 bind a11y safe coercible slice from Push immer spring Microsoft hasOwn react-testing-library push scheme-validation agent form-validation $.extend rm -rf protocol-buffers reduce prototype flag preprocessor formatting jasmine preserve-symlinks Object.fromEntries Stream xml generics sharedarraybuffer getOwnPropertyDescriptor -0 estree mime es7 nodejs stringifier ECMAScript 2022 yaml remove flatten es-shims colour ts pyyaml s3 sham style airbnb length Function.prototype.name shared es-abstract styling settings ES7 command-line group flatMap bundling language framer match styleguide extra jsx worker TypeBox stateless Reflect.getPrototypeOf byteLength

`@a-2-c-2-anpm/atque-doloremque-autem`

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

React specific linting rules for eslint

Installation

npm install eslint @a-2-c-2-anpm/atque-doloremque-autem --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 @a-2-c-2-anpm/atque-doloremque-autem 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 @a-2-c-2-anpm/atque-doloremque-autem is a plugin object.

const react = require('@a-2-c-2-anpm/atque-doloremque-autem');
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.

@a-2-c-2-anpm/atque-doloremque-autem/configs/all
@a-2-c-2-anpm/atque-doloremque-autem/configs/recommended
@a-2-c-2-anpm/atque-doloremque-autem/configs/jsx-runtime

If your eslint.config.js is ESM, include the .js extension (e.g. @a-2-c-2-anpm/atque-doloremque-autem/recommended.js). Note that the next semver-major will require omitting the extension for these imports.

Note: These configurations will import @a-2-c-2-anpm/atque-doloremque-autem 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('@a-2-c-2-anpm/atque-doloremque-autem/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('@a-2-c-2-anpm/atque-doloremque-autem/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('@a-2-c-2-anpm/atque-doloremque-autem/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: @a-2-c-2-anpm/atque-doloremque-autem-hooks
JSX accessibility: eslint-plugin-jsx-a11y
React Native: @a-2-c-2-anpm/atque-doloremque-autem-native

License

@a-2-c-2-anpm/atque-doloremque-autem is licensed under the MIT License.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@a-2-c-2-anpm/atque-doloremque-autem

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

`@a-2-c-2-anpm/atque-doloremque-autem`

Configuration (legacy: `.eslintrc*`)

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