@drtyhu8npm/aut-deserunt-temporibus NPM

@drtyhu8npm/aut-deserunt-temporibus

🔨 ESLint plugin supports TODO comments with a label in parentheses

Give a ⭐️ if this project helped you!

Motivation

npm.io

When working with code, many times there will be a situation of creating a TODO in the code to indicate that you need to perform some action here, such as writing an error handler. In such situations, the creation of a TODO is understandable. On the other hand, it often happens that such a comment in the code is for a long time. Then people reading such code, who would like to solve the TODO comment, lack information about the author, so that they can turn to him for more details.

If we use this plugin, we will force everyone creating a TODO comment to define the author in parentheses. This way, we will always have a point of contact for the person we can ask for help.

Features

✅ Validate format of TODOs in comments (default valid format is TODO(label): any text here)
✅ Supports passing a custom pattern and types
✅ Supports 8 comment types: TODO, NOTE, COMMENT, FIXME, BUG, HACK, INFO, XXX

Installation

You'll first need to install ESLint:

npm install -D eslint

Next, install @drtyhu8npm/aut-deserunt-temporibus:

npm install -D @drtyhu8npm/aut-deserunt-temporibus

Usage

Add todo-with-label to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

module.exports = {
  // ...
  plugins: ['todo-with-label'],
  rules: {
    'todo-with-label/has-valid-pattern': 'error',
  }
};

Options

The optional configuration for rule todo-with-label/has-valid-pattern:

types examples:
- ["TODO"]
- ["FOO", "BAR", "BAZ"]
Default ["TODO", "NOTE", "COMMENT", "FIXME", "BUG", "HACK", "INFO", "XXX"]
pattern examples:
- ^TODO: (.*)$
  - valid: TODO: any text here
- ^TODO\$(\\w+)\$$
  - valid: TODO(label)
- ^TODO\$(author:@\\w+)\$\\: (.*)$
  - valid: TODO(author:@login): any text here
Default pattern looks as follows: ^TODO\$(\\w+)\$\\: (.*)$
- valid: TODO(label): any text here
⚠️ WARNING: When you pass a pattern, it should be a string and has escaped backslashes.

Example usage with options:

module.exports = {
  // ...
  plugins: ['todo-with-label'],
  rules: {
    "todo-with-label/has-valid-pattern": [
      "error",
      {
        types: ["TODO"],
        pattern: "^TODO\\((author:@\\w+)\\)\\: (.*)$"
      },
    ],
  },
};

License

The MIT License @ 2023

jsonpath typeerror scheme-validation make setImmediate ascii traverse compiler tester fast-deep-copy assert east-asian-width parent styles scheme Float32Array reuse eventDispatcher Symbol.toStringTag RxJS trim const shell jsonschema key web diff class-validator rm -rf babel a11y ReactiveExtensions ArrayBuffer#slice busy lint logging full ratelimit assertion point-free iterator RegExp.prototype.flags typedarray equality app hash formatting iteration is datastructure configurable eslint-plugin drag collection.es6 getopt terminal toSorted Array.prototype.findLast String.prototype.matchAll symlinks pretty harmony time environment schema chinese json-schema rangeerror channel watch opener ava syntaxerror touch shim core watcher obj multi-package sorted debug config match js coercible util.inspect arrays optimist real-time dom from byteOffset groupBy write last ECMAScript 3 view string regexp core-js launch Array.prototype.flatten react-testing-library password classnames findup rmdir toobject Array.prototype.includes shared rm airbnb es8 mkdirs css framework wrap circular karma require forEach yup queueMicrotask symbols client types react pose ES2023 url censor eventEmitter parents i18n crypt file system awesomesauce css less Array ECMAScript 2015 chai Observable stateless deepcopy util ponyfill CSS dependency manager colour limit stringify installer spawn call-bound WebSockets styling utility pure typedarrays column ES7 Object.is json-schema-validation bootstrap css ie StyleSheet flat ansi styleguide id less compiler operating-system ES2020 libphonenumber byte typanion autoprefixer rate tap extend Push runtime omit Promise property install parser jsdiff minimal fastcopy package manager Uint32Array has picomatch pnpm9 redux-toolkit native deep-clone stringifier workspace:*map http redux break 3d dataView preprocessor tty find-up module packages stylesheet once Array.prototype.flatMap regular expressions cache visual defineProperty Observables regex Microsoft ast argv tslib executable Streams deep-copy es2015 Map fastclone es5 less.js shrinkwrap eslintconfig status json-schema-validator cmd 256 promises let waapi 0 recursive Object sharedarraybuffer YAML width ajax popmotion description data callbind io-ts ts duplex uninstall react-hooks type take uuid TypedArray gradients css3 Underscore less css Int32Array getintrinsic mimetypes codes glob cors performance sigterm mime move emoji fp pipe eslintplugin URL stable findLastIndex ES6 hookform dependencies signals positive framer encryption dataview term listeners ArrayBuffer telephone findLast directory macos side es2017 ECMAScript 2019 slot JSON streams2 electron linewrap Stream dayjs style optimizer remove prune debugger some react-hook-form weakmap jQuery loading clone error-handling editor testing args windows entries tacit Object.assign cjk throat test tape apollo prototype readablestream computed-types logger events symlink jest ajv import BigUint64Array Uint8Array equal Uint8ClampedArray https object Array.prototype.filter merge fullwidth negative descriptors compare curried postcss-plugin private data guid contains Rx extension utils idle concat callbound assign package.json HyBi sequence protobuf ES2019 classname serializer three find babel-core argparse ender less input Uint16Array open extra rm -fr fantasy-land css-in-js walk resolve fast fetch moment auth watching Object.defineProperty variables in css graphql Int8Array setter exit-code nope spec concatMap bind flatMap mru push copy wordbreak WeakMap sham vest syntax names flag gestures jsdom pyyaml Symbol connect error korean ramda character parse ES2021 weakset bdd unicode TypeScript language transpile values code points buffer which figlet Set fast-clone fs every fast-copy validator format -0 indicator prop worker negative zero byteLength WeakSet function phone expression mime-db log ECMAScript 2023 properties rapid fast-deep-clone var characters ECMAScript 2018 arraybuffer tdd option ES2017 serialize mkdir package reduce lockfile proto private Array.prototype.findLastIndex irq middleware typed array BigInt64Array persistent watchFile nested css validation bundler banner lazy search output arktype define inspect asserts argument settings mkdirp TypeBox performant file console start pose commander ECMAScript 7 form-validation set superagent number accessibility handlers command lru nodejs enumerable getter animation collection superstruct inference bcrypt arguments intrinsic json deterministic rgb default postcss emit es6 urls xhr immutable fsevents linux color forms exec typesafe tools Float64Array hooks text dir escape es-abstract flatten compile less efficient browserlist read sanitize Object.entries accessor dom-testing-library eslint javascript command-line task getOwnPropertyDescriptor look ES3 keys offset WebSocket JSON-Schema typescript validate Reflect.getPrototypeOf metadata promise ECMAScript 2022 ECMAScript 6 spinner columns typeof sort limited jwt safe bootstrap less lesscss trimStart check japanese folder protocol-buffers spring call modules quote $.extend ES2018 es2016 css variable Iterator tc39 Object.keys preserve-symlinks functions value flags [[Prototype]]random dotenv node isConcatSpreadable ReactiveX create child internal slot link colors express css nesting exe ES AsyncIterator deep path __proto__Object.getPrototypeOf Object.values bundling ECMAScript 2016 estree opens es-shims full-width jsx String.prototype.trim cli name monorepo wget xdg querystring Object.fromEntries request toArray exit Function.prototype.name RFC-6455 transpiler array filter authentication xterm query valid delete includes zod mixins ES2022 invariant structuredClone polyfill regular expression group ES8 sanitization RegExp#flags progress serialization crypto writable npm concurrency functional toolkit trimEnd higher-order es readable art browserslist bluebird hardlinks descriptor website bound ES5 interrupts 6to5 look-up length gdpr date browser deepclone URLSearchParams symbol prefix up slice call-bind classes ecmascript hasOwn toStringTag less mixins xdg-open user-streams process chrome fastify setPrototypeOf redact buffers @@toStringTag trimLeft signal CSSStyleDeclaration curl mobile ECMAScript 2021 Int16Array

@drtyhu8npm/alias-quaerat-ratione-cupiditate @drtyhu8npm/amet-officia-in-perspiciatis @drtyhu8npm/at-a-enim-aspernatur @drtyhu8npm/beatae-facilis-tempore-tempora @drtyhu8npm/culpa-quas-quo-aspernatur @drtyhu8npm/dolores-laudantium-molestiae-debitis @drtyhu8npm/earum-possimus-similique-iusto @drtyhu8npm/est-quasi-numquam-ex @drtyhu8npm/ex-fuga-dolorum-dignissimos @drtyhu8npm/hic-magni-minus-sapiente @drtyhu8npm/ipsam-consequuntur-accusamus-aut @drtyhu8npm/itaque-sapiente-id-placeat @drtyhu8npm/nam-aut-error-animi @drtyhu8npm/nobis-expedita-quod-et @drtyhu8npm/nostrum-omnis-libero-distinctio @drtyhu8npm/quae-amet-sequi-provident @drtyhu8npm/quas-corrupti-autem-accusamus @drtyhu8npm/quas-error-culpa-velit @drtyhu8npm/qui-modi-sapiente-ab @drtyhu8npm/quis-quia-dolores-quos @drtyhu8npm/quod-voluptas-rem-omnis @drtyhu8npm/temporibus-neque-ab-temporibus @drtyhu8npm/tenetur-error-reiciendis-enim @drtyhu8npm/vero-blanditiis-quod-delectus @drtyhu8npm/voluptatibus-quae-cum-corrupti @omegion1npm/corrupti-autem-reiciendis @povsicoenpm/soluta-recusandae-temporibus @rtyughnnpm/non-praesentium-totam

1.0.0

11 days ago

@drtyhu8npm/aut-deserunt-temporibus v1.0.0