Skip to content

HiddenAbilitree/opinionated-defaults

Repository files navigation

Banner

Demo

A collection of opinionated web-dev tooling configurations.

GitHub Tag NPM Downloads GitHub License GitHub Actions Workflow Status

Bun TypeScript Rust

Quickstart

Note

The package manager that the CLI will use to install this package is dependent on what lockfile you have in the root of your project (i.e., having bun.lock will use bun, while having package-lock.json will use npm).

Currently, the only supported package managers are bun and npm.

This package contains a CLI that generates config files for your project. It will prompt you to choose between ESLint + Prettier or Oxlint + Oxfmt.

bunx @hiddenability/opinionated-defaults
npx @hiddenability/opinionated-defaults

You can skip the prompt with flags:

bunx @hiddenability/opinionated-defaults -es  # ESLint + Prettier
bunx @hiddenability/opinionated-defaults -ox  # Oxlint + Oxfmt

Supported Framework Configurations:

Eslint:

  • Astro
  • Elysia.js
  • Next.js

Exports:

  • eslintConfig (Used to provide autocomplete)
  • eslintConfigAstro (Astro)
  • eslintConfigBase (General rules for every project)
  • eslintConfigElysia (Elysia.js)
  • eslintConfigFunctional (Enforces functional style)
  • eslintConfigNext (Next.js)
  • eslintConfigOxlint (Disables ESlint rules available in Oxlint)
  • eslintConfigPrettier (Runs Prettier as ESLint rules)
  • eslintConfigReact (General rules for React)
  • eslintConfigRelative (Enforces the use of absolute import paths using path aliases)
  • eslintConfigStylistic (Enforces code-style through ESLint rules)
  • eslintConfigTurbo (Turborepo)

Included plugins:

Oxlint (ESLint replacement):

Exports:

  • oxlintConfig (Config object for oxlint.config.ts)

Enabled plugins:

  • typescript
  • unicorn
  • oxc
  • import
  • react
  • react-perf
  • nextjs
  • promise
  • node
  • jsx-a11y

Oxfmt (Prettier replacement):

Exports:

  • oxfmtConfig (Config object for oxfmt.config.ts)

Built-in features:

  • Import sorting (with newlines between groups)
  • Tailwind CSS class sorting (supports cva, clsx, cn)

Prettier:

  • Astro
  • Next.js
  • +Opinionated defaults

Exports:

  • prettierConfig (Used to merge configurations and provide autocomplete)
  • prettierConfigAstro (Astro prettier rules with Tailwind class ordering)
  • prettierConfigNext (Rules for Next.js with Tailwind class ordering)
  • prettierConfigBase (General rules for every project)
  • prettierConfigSortImports (Prettier-based import sorting)

Included plugins:

Manual Installation:

Alternatively, you can install it manually by running one of the following commands.

bun add @hiddenability/opinionated-defaults -d
npm i @hiddenability/opinionated-defaults -D

Usage:

Oxlint:

// oxlint.config.ts
import { defineConfig } from 'oxlint';
import { oxlintConfig } from '@hiddenability/opinionated-defaults/oxlint';

export default defineConfig(oxlintConfig);

Oxfmt:

// oxfmt.config.ts
import { defineConfig } from 'oxfmt';
import { oxfmtConfig } from '@hiddenability/opinionated-defaults/oxfmt';

export default defineConfig(oxfmtConfig);

Eslint:

// eslint.config.ts
import {
  eslintConfig,
  eslintConfigBase,
} from '@hiddenability/opinionated-defaults/eslint';

export default eslintConfig([
  ...eslintConfigBase,
  // ...eslintConfigPrettier, // other configs fit right in!
  // { /* your rules here */ },
]);

Prettier:

// prettier.config.mjs
import {
  prettierConfig,
  prettierConfigBase,
} from '@hiddenability/opinionated-defaults/prettier';

export default prettierConfig(prettierConfigBase);

Extending/Combining Prettier Configs:

Since Prettier uses a configuration object instead of a flat config like ESLint, to extend or combine configurations, the prettierConfig function will merge configs for you.

// prettier.config.mjs
import {
  prettierConfig,
  prettierConfig1,
  prettierConfig2,
} from '@hiddenability/opinionated-defaults/prettier';

export default prettierConfig(
  prettierConfig1,
  prettierConfig2,
  {
    /* your custom rules */
  },
  /*...*/
);

TailwindCSS Plugin:

When using prettier-config-tailwind, make sure to specify the CSS file that contains the @import "tailwindcss" directive.

For example, given the following css file:

/* /app/styles.css */
@import 'tailwindcss';

This could be a minimal version of your Prettier config:

// prettier.config.mjs
import {
  prettierConfig,
  prettierConfigBase,
  prettierConfigTailwind,
} from '@hiddenability/opinionated-defaults/prettier';

export default prettierConfig(prettierConfigBase, prettierConfigTailwind, {
  tailwindStylesheet: `./app/styles.css`,
});

TODO:

  • Improve repository structure (How to manage configuration options within eslint dir?).
  • Maybe convert into monorepo with one package per tool instead of multiple exports from one package.
  • Prevent importing overlapping configurations (i.e., Next.js ESLint config contains base config).
  • Support node module resolution.
  • Maybe make declarative configurations instead of just providing wrapped config modules.

About

A collection of opinionated tooling configurations.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors