Skip to content

Repository files navigation

@rdlabo/eslint-plugin-rules

npm version License: MIT

Shared code conventions for Angular and Ionic applications, with framework-independent TypeScript presets for Cloudflare Workers. Catch inconsistent component boundaries, template usage, and implicit timezone operations during linting, before they reach code review.

Try lint detection and autofix in a small TypeScript project, without installing Angular or Ionic.

Install

Install the plugin as a development dependency in an ESLint project:

npm install --save-dev @rdlabo/eslint-plugin-rules

For Angular and Ionic rules, also install the corresponding framework peers below. For a complete setup, follow Configuration.

Requirements

Package Supported version
Node.js 20 or later
ESLint 9 or later
@typescript-eslint/utils 8.33 or later, before 9
@angular-eslint/template-parser 21.x or 22.x
@ionic/angular 9.x when Ionic rules are used
@ionic/core 9.x when Ionic rules are used

Choose an entry point

Preset Entry point Purpose
recommended @rdlabo/eslint-plugin-rules Angular and Ionic conventions for TypeScript and HTML
workers/recommended @rdlabo/eslint-plugin-rules/typescript Opt-in Workers try/catch policy
workers-timezone/recommended @rdlabo/eslint-plugin-rules/typescript Opt-in companion policy for @rdlabo/workers-timezone

The Angular recommended preset ships with the package root. The two Workers presets are independent opt-ins on /typescript; neither includes the other. For timezone conversions and checks, pair with @rdlabo/workers-timezone. Flat Config selectors and Ionic list structure live in Configuration.

Documentation

  • Configuration — copy a setup for Angular/Ionic, TypeScript, or Workers.
  • Rules — compare preset coverage, options, and examples.
  • Migration guide — update an existing installation.

Full documentation: https://docs.rdlabo.dev/projects/eslint-plugin-rules

Support This Project

Enjoying this project? Your support helps keep it alive and growing. Sponsoring means you directly contribute to new features, improvements, and maintenance.

Become a Sponsor

Prerelease channels

An open, non-draft pull request can be published to the npm beta dist-tag after its CI and Package Candidate workflows pass. A repository owner or maintainer must add a comment whose entire body is:

/beta

The request authorizes only the pull request head SHA that existed when the comment was added. The workflow revalidates the owner or maintainer permission and head SHA immediately before publishing. Any new commit requires CI to pass again and a fresh owner or maintainer /beta comment. Fork pull requests are supported. Pull requests that change a release-gating workflow cannot be beta-published until those workflow changes land on main.

Beta versions use <base>-beta.pr<PR number>.sha<12-character SHA>. The candidate is built in a read-only workflow without npm publishing credentials. The privileged release workflow publishes only the validated immutable package artifact with lifecycle scripts disabled. A notification failure cannot invalidate a successful npm publish.

When a pull request is merged into main, it is automatically published to beta only after the required CI and Package Candidate succeed for that exact merge commit. Direct pushes to main do not publish a candidate.

Only npm run release creates a release tag. Stable vX.Y.Z tags publish to npm latest; revision/prerelease tags publish to next. Neither beta nor next publishing changes the npm latest dist-tag.

Maintainers

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

rdlabo's custom eslint rules

Resources

Contributing

Security policy

Stars

7 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages