@helfy/helfy-lint weekly downloads statistics

@helfy/helfy-lint

ESLint rules and a Prettier plugin for Helfy apps. The rules enforce the layer model: @Store holds state, @Service does infrastructure work, @UseCase orchestrates both, @View renders.

npm install -D @helfy/helfy-lint eslint @typescript-eslint/parser

ESLint

// eslint.config.mjs
import helfy from "@helfy/helfy-lint";
import tsParser from "@typescript-eslint/parser";

export default [
  {
    files: ["src/**/*.{ts,tsx}"],
    languageOptions: { parser: tsParser },
    ...helfy.configs.recommended,
  },
];

Rule	In recommended
helfy/store/no-inject — no @inject / @useCtx on @Store	error
helfy/store/no-ctor-params — @Store has an empty constructor	error
helfy/store/no-effect — no @effect on @Store	error
helfy/store/computed-only-on-getter — @computed only on getters	error
helfy/store/no-http-calls — no HTTP, storage or timer I/O in @Store	error
helfy/service/no-state, no-computed, no-effect — no reactivity in @Service	error
helfy/service/no-field-inject — dependencies through the constructor	error
helfy/use-case/no-reactive-decorators — no @state / @computed / @effect in @UseCase	error
helfy/use-case/no-field-inject — dependencies through the constructor	error
helfy/layers/no-store-imports-service, no-store-imports-use-case, no-service-imports-use-case	error
helfy/view/no-ctor-di — @View takes dependencies with @inject, not the constructor	error
helfy/view/no-destructure-props — destructuring this.props loses reactivity	warn
helfy/imports/no-deep-helfy-imports — no @helfy/helfy/dist/...	error
helfy/imports/no-unknown-helfy-subpath — only documented @helfy/helfy/* entries	error

Build-time checks

@helfy/helfy/babel-preset already fails the build on the rules that are never valid (store/no-inject, store/no-effect, store/no-ctor-params, service/no-*, use-case/no-reactive-decorators, imports/no-deep-helfy-imports); this package is not needed for that. For a Babel setup without the preset, the same plugin is available on its own:

{ "plugins": ["@helfy/helfy-lint/babel"] }

Prettier for .hf

// prettier.config.cjs
module.exports = {
  plugins: [require.resolve("@helfy/helfy-lint/prettier")],
  overrides: [{ files: "*.hf", options: { parser: "helfy-hf" } }],
};

The formatter is the one the Helfy language server uses. A file with syntax errors is left as is.

License

MIT