@skylernpm/dolore-expedita-magnam

v1.0.0

Published

7 months ago

[@skylernpm/dolore-expedita-magnam](https://www.npmjs.com/package/@skylernpm/dolore-expedita-magnam) is ESLint plugin for finding RegExp mistakes and RegExp style guide violations.

Downloads

0High
0Medium
0Low

skylerlabsventure

hookform make superstruct HyBi [[Prototype]]filter fastify pipe __proto__rangeerror shebang quote ansi look-up rgb shim l10n karma rm number lockfile open cloudsearch log queueMicrotask deepclone multi-package arraybuffer promise fast-clone hot storagegateway less css slot router es8 rapid environments performance parser loading Map url chrome delete ES2017 character art find diff ES7 ratelimit eslint metadata equal cloudformation concurrency xdg-open airbnb launch testing warning ES2019 hardlinks ES2015 express eslintconfig Object.values type variables Iterator shared ECMAScript 3 jwt elasticache endpoint toobject install handlers prototype regex regular jsx less proto getintrinsic middleware Stream signals bdd es-abstract parse call nodejs flux libphonenumber eslint-plugin throttle setImmediate wait await core Array.prototype.flatten iterator Underscore Symbol tty whatwg dataview rmdir live which state rm -rf uninstall types kinesis schema expression object east-asian-width irq iam website serialization busy link weakset forEach lint Uint8Array css nesting syntax fast-deep-clone dynamodb Object.fromEntries css less ES3 URL random stateless ecmascript monorepo commander fetch Object.defineProperty mocha css-in-js prefix immer BigInt64Array inspect installer sqs some syntaxerror es-shims codes jsdom set status polyfill loadbalancing ast once merge accessibility ArrayBuffer.prototype.slice css variable react is stdlib negative typesafe fastcopy characters process folder ajv typed stylesheet fast-deep-copy nested css classnames term length ses group ender String.prototype.matchAll eslintplugin vpc data logging bind descriptor operating-system contains wordbreak array match class-validator language setPrototypeOf groupBy batch full-width obj ava chinese importexport emr flatten cli ajax editor functions performant call-bound Object higher-order compiler module unicode xdg take exit getOwnPropertyDescriptor packages elb ES6 ECMAScript 6 wget jshint intrinsic emit stable rfc4122 move tools traverse format watcher formatting react-hooks WeakMap ECMAScript 7 command-line invariant symlinks key Object.keys colour reduce computed-types output bootstrap less framework ArrayBuffer crypt compile less in query internal callback regular expressions id get exec windows safe concat shell inference validate make dir push function findLastIndex input settings directory trimRight es5 isConcatSpreadable password interrupts look dotenv test amazon tostringtag moment javascript concatMap global redux styles resolve curl yup ts mkdir parents indicator Int16Array form-validation Int32Array es2018 styled-components spawn JSON-Schema ReactiveX Array copy has-own error-handling eventEmitter restful Array.prototype.flatMap extra Int8Array duplex map react-testing-library opens nope ESnext CSS check trim runtime tape ArrayBuffer#slice encryption prop hasOwn Uint16Array value visual weakmap utility sns serializer trimEnd react-hook-form authentication fast name Reflect.getPrototypeOf args fs Symbol.toStringTag zod -0 ECMAScript 2022 chai fast-copy file a11y property gradients css3 start string bundling signal chromium browser default Set ES2020 asserts sigterm sorted arrays Object.is functional classes getopt .env offset typescript exe description config preprocessor internal slot byteLength joi flag limited break npm dir AsyncIterator tslib elm native byteOffset dom-testing-library cloudwatch helpers redact lru ECMAScript 2015 jsdiff StyleSheet yaml sigint japanese search ES5 getter request mixins pyyaml lazy speed tap Uint32Array workspace:*Uint8ClampedArray columns JSON time util.inspect recursive argparse private buffer setter environment node argv ES2021 prune s3 ES2023 superagent full option ES2018 typeerror Promise electron date file system assign mapreduce symlink streams2 rds scheme-validation generics RegExp.prototype.flags walking hooks listeners consume fsevents debugger gradients css define Array.prototype.flat workflow ECMAScript 2019 Object.assign styling entries vest ebs ES fullwidth bundler sharedarraybuffer optimist create querystring remove argument path figlet ec2 es2015 jest events i18n browserlist auth Observable less mixins package assert real-time wrap slice beanstalk replay from terminal pnpm9 style identifiers opener mimetypes watching hasOwnProperty iterate last awesomesauce protobuf private data getPrototypeOf iteration forms String.prototype.trim toolkit optimizer proxy linux deepcopy fps picomatch less.js TypeScript includes https datastructure postcss predictable reducer assertion css hash bluebird require matches call-bind column es-shim API package manager logger arguments immutable walk dataView ES8 serialize plugin keys stringifier executable callbound styleguide web idle console rest mime-db Array.prototype.includes phone own import preserve-symlinks gdpr Function.prototype.name linewrap urls validation wordwrap Array.prototype.findLast arktype Rx macos es2016 es7 cloudfront less compiler ECMAScript 2023 positive accessor lesscss classname drop Array.prototype.findLastIndex typedarray symbol RFC-6455 omit WebSockets limit TypeBox cloudtrail http glob enumerable debug Float64Array bound ECMAScript 2018 ie deep-copy text efficient ECMAScript 2017 waf configurable variables in css toStringTag io-ts censor typed array mkdirp descriptors spec jQuery @@toStringTag every regexp globals Array.prototype.contains Microsoft fastclone view negative zero ascii has js BigUint64Array estree values toArray korean throat glacier emoji tester readable find-up ES2016 color spinners parent ECMAScript 2016 WebSocket cors defineProperty toSorted 0 ReactiveExtensions byte zero sham ECMAScript 2021 rate findLast exit-code protocol-buffers WeakSet task guid patch watchFile width promises browserslist trimLeft simpledb telephone parsing aws env YAML scheme postcss-plugin core-js redux-toolkit names autoprefixer crypto $.extend bootstrap css stringify ECMAScript 5 command RegExp#flags mru worker es2017 mime coercible clone json persistent qs structuredClone vars mkdirs compare dom robust bcrypt typanion sort trimStart spinner Array.prototype.filter colors typeof readablestream sameValueZero autoscaling Float32Array deterministic tc39 Object.entries equality tdd error code points TypedArray es6 utilities es sequence modules _.extend write deep flatMap app async shrinkwrap deep-clone RxJS URLSearchParams package.json uuid ECMAScript 2020 callbind reuse cmd ES2022 connect Push findup minimal banner ponyfill form writable flat extension jsonpath up side valid starter read

Introduction

@skylernpm/dolore-expedita-magnam is ESLint plugin for finding RegExp mistakes and RegExp style guide violations.

:name_badge: Features

This ESLint plugin provides linting rules relate to better ways to help you avoid problems when using RegExp.

Find the wrong usage of regular expressions, and their hints.
Enforces a consistent style of regular expressions.
Find hints for writing optimized regular expressions.
80 plugin rules for regular expression syntax and features.

You can check on the Online DEMO.

:book: Documentation

See documents.

:cd: Installation

npm install --save-dev eslint @skylernpm/dolore-expedita-magnam

Requirements
ESLint v8.44.0 and above
Node.js v18.x, v20.x and above

:book: Usage

Add regexp to the plugins section of your eslint.config.js or .eslintrc configuration file (you can omit the eslint-plugin- prefix) and either use one of the two configurations available (recommended or all) or configure the rules you want:

The recommended configuration (New Config)

The plugin.configs["flat/recommended"] config enables a subset of the rules that should be most useful to most users. See lib/configs/rules/recommended.ts for more details.

// eslint.config.js
import * as regexpPlugin from "@skylernpm/dolore-expedita-magnam"

export default [
    regexpPlugin.configs["flat/recommended"],
];

The recommended configuration (Legacy Config)

The plugin:regexp/recommended config enables a subset of the rules that should be most useful to most users. See lib/configs/rules/recommended.ts for more details.

// .eslintrc.js
module.exports = {
    "plugins": [
        "regexp"
    ],
    "extends": [
         // add more generic rulesets here, such as:
         // 'eslint:recommended',
        "plugin:regexp/recommended"
    ]
}

Advanced Configuration

Override/add specific rules configurations. See also: http://eslint.org/docs/user-guide/configuring.

// eslint.config.js
import * as regexpPlugin from "@skylernpm/dolore-expedita-magnam"

export default [
    {
        plugins: { regexp: regexpPlugin }
        rules: {
            // Override/add rules settings here, such as:
            "regexp/rule-name": "error"
        }
    }
];

// .eslintrc.js
module.exports = {
    "plugins": [
        "regexp"
    ],
    "rules": {
        // Override/add rules settings here, such as:
        "regexp/rule-name": "error"
    }
}

Using the all configuration

The plugin.configs["flat/all"] / plugin:regexp/all config enables all rules. It's meant for testing, not for production use because it changes with every minor and major version of the plugin. Use it at your own risk. See lib/configs/rules/all.ts for more details.

:white_check_mark: Rules

💼 Configurations enabled in.
⚠️ Configurations set to warn in.
🟢 Set in the flat/recommended configuration.
🔵 Set in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.
💡 Manually fixable by editor suggestions.

Possible Errors

Best Practices

| Name | Description | 💼 | ⚠️ | 🔧 | 💡 | | :----------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | :---- | :---- | :- | :- | | confusing-quantifier | disallow confusing quantifiers | | 🟢 🔵 | | | | control-character-escape | enforce consistent escaping of control characters | 🟢 🔵 | | 🔧 | | | negation | enforce use of escapes on negation | 🟢 🔵 | | 🔧 | | | no-dupe-characters-character-class | disallow duplicate characters in the RegExp character class | 🟢 🔵 | | 🔧 | | | no-empty-string-literal | disallow empty string literals in character classes | 🟢 🔵 | | | | | no-extra-lookaround-assertions | disallow unnecessary nested lookaround assertions | 🟢 🔵 | | 🔧 | | | no-invisible-character | disallow invisible raw character | 🟢 🔵 | | 🔧 | | | no-legacy-features | disallow legacy RegExp features | 🟢 🔵 | | | | | no-non-standard-flag | disallow non-standard flags | 🟢 🔵 | | | | | no-obscure-range | disallow obscure character ranges | 🟢 🔵 | | | | | no-octal | disallow octal escape sequence | | | | 💡 | | no-standalone-backslash | disallow standalone backslashes (\) | | | | | | no-trivially-nested-assertion | disallow trivially nested assertions | 🟢 🔵 | | 🔧 | | | no-trivially-nested-quantifier | disallow nested quantifiers that can be rewritten as one quantifier | 🟢 🔵 | | 🔧 | | | no-unused-capturing-group | disallow unused capturing group | 🟢 🔵 | | 🔧 | 💡 | | no-useless-character-class | disallow character class with one character | 🟢 🔵 | | 🔧 | | | no-useless-flag | disallow unnecessary regex flags | | 🟢 🔵 | 🔧 | | | no-useless-lazy | disallow unnecessarily non-greedy quantifiers | 🟢 🔵 | | 🔧 | | | no-useless-quantifier | disallow quantifiers that can be removed | 🟢 🔵 | | 🔧 | 💡 | | no-useless-range | disallow unnecessary character ranges | 🟢 🔵 | | 🔧 | | | no-useless-set-operand | disallow unnecessary elements in expression character classes | 🟢 🔵 | | 🔧 | | | no-useless-string-literal | disallow string disjunction of single characters in \q{...} | 🟢 🔵 | | 🔧 | | | no-useless-two-nums-quantifier | disallow unnecessary {n,m} quantifier | 🟢 🔵 | | 🔧 | | | no-zero-quantifier | disallow quantifiers with a maximum of zero | 🟢 🔵 | | | 💡 | | optimal-lookaround-quantifier | disallow the alternatives of lookarounds that end with a non-constant quantifier | | 🟢 🔵 | | 💡 | | optimal-quantifier-concatenation | require optimal quantifiers for concatenated quantifiers | 🟢 🔵 | | 🔧 | | | prefer-escape-replacement-dollar-char | enforces escape of replacement $ character ($$). | | | | | | prefer-predefined-assertion | prefer predefined assertion over equivalent lookarounds | 🟢 🔵 | | 🔧 | | | prefer-quantifier | enforce using quantifier | | | 🔧 | | | prefer-range | enforce using character class range | 🟢 🔵 | | 🔧 | | | prefer-regexp-exec | enforce that RegExp#exec is used instead of String#match if no global flag is provided | | | | | | prefer-regexp-test | enforce that RegExp#test is used instead of String#match and RegExp#exec | | | 🔧 | | | prefer-set-operation | prefer character class set operations instead of lookarounds | 🟢 🔵 | | 🔧 | | | require-unicode-regexp | enforce the use of the u flag | | | 🔧 | | | require-unicode-sets-regexp | enforce the use of the v flag | | | 🔧 | | | simplify-set-operations | require simplify set operations | 🟢 🔵 | | 🔧 | | | sort-alternatives | sort alternatives if order doesn't matter | | | 🔧 | | | use-ignore-case | use the i flag if it simplifies the pattern | 🟢 🔵 | | 🔧 | |

Stylistic Issues

Removed

:no_entry: These rules have been removed in a previous major release, after they have been deprecated for a while.

| Rule ID | Replaced by | Removed in version | |:--------|:------------|:-------------------| | no-assertion-capturing-group | regexp/no-empty-capturing-group | v2.0.0 | | no-useless-exactly-quantifier | regexp/no-useless-quantifier, regexp/no-zero-quantifier | v2.0.0 | | no-useless-non-greedy | regexp/no-useless-lazy | v2.0.0 | | order-in-character-class | regexp/sort-character-class-elements | v2.0.0 | | prefer-t | regexp/control-character-escape | v2.0.0 |

:gear: Settings

See Settings.

:traffic_light: Semantic Versioning Policy

@skylernpm/dolore-expedita-magnam follows Semantic Versioning and ESLint's Semantic Versioning Policy.

:beers: Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

See CONTRIBUTING.md.

Development Tools

npm test runs tests and measures coverage.
npm run update runs in order to update readme and recommended configuration.
npm run new [new rule name] runs to create the files needed for the new rule.
npm run docs:watch starts the website locally.

:lock: License

See the LICENSE file for license rights and limitations (MIT).