@ocavue/eslint-config 1.0.0 → 1.1.0

package/README.md

@@ -5,6 +5,7 @@ A set of ESLint shareable configs for TypeScript projects.
 - Out of the box support for TypeScript, React, and Markdown
 - Sort your imports
 - Sort your fields in `package.json`
+- Prefer top-level function declarations over function expressions
 
 ## Install
 
@@ -75,3 +76,8 @@ If you are using VS Code, you and install [ESLint extension](https://marketplace
   }
 }
 ```
+
+## Inspired by
+
+- https://github.com/antfu/eslint-config
+- https://github.com/sxzz/eslint-config

package/dist/src/antfu.d.ts

@@ -0,0 +1,2 @@
+export function antfu(): import("eslint-define-config").FlatESLintConfigItem[];
+//# sourceMappingURL=antfu.d.ts.map

package/dist/src/antfu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"antfu.d.ts","sourceRoot":"","sources":["../../src/antfu.js"],"names":[],"mappings":"AAEA,+EAcC"}

package/dist/src/basic.d.ts

@@ -1,3 +1,10 @@
+/**
+ * @typedef {Object} BasicOptions
+ * @property {import('./typescript.js').TypescriptOptions} [typescript]
+ */
+/**
+ * @param {BasicOptions} [options]
+ */
 export function basic(options?: BasicOptions | undefined): import("eslint-define-config").FlatESLintConfigItem[];
 export type BasicOptions = {
     typescript?: import("./typescript.js").TypescriptOptions | undefined;

package/dist/src/basic.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"basic.d.ts","sourceRoot":"","sources":["../../src/basic.js"],"names":[],"mappings":"AAkBO,iHAgBN"}
+{"version":3,"file":"basic.d.ts","sourceRoot":"","sources":["../../src/basic.js"],"names":[],"mappings":"AAWA;;;GAGG;AAEH;;GAEG;AACH,iHAiBC"}

package/dist/src/imports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"imports.d.ts","sourceRoot":"","sources":["../../src/imports.js"],"names":[],"mappings":"AAKO,iFA0CN"}
+{"version":3,"file":"imports.d.ts","sourceRoot":"","sources":["../../src/imports.js"],"names":[],"mappings":"AAKA,iFA0CC"}

package/dist/src/markdown.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/markdown.js"],"names":[],"mappings":"AAOO,kFA0DN"}
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/markdown.js"],"names":[],"mappings":"AAOA,kFA0DC"}

package/dist/src/no-only-tests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-only-tests.d.ts","sourceRoot":"","sources":["../../src/no-only-tests.js"],"names":[],"mappings":"AAKO,qFAcN"}
+{"version":3,"file":"no-only-tests.d.ts","sourceRoot":"","sources":["../../src/no-only-tests.js"],"names":[],"mappings":"AAKA,qFAcC"}

package/dist/src/package-json.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Sort package.json keys
+ */
 export function packageJson(): import("eslint-define-config").FlatESLintConfigItem[];
 //# sourceMappingURL=package-json.d.ts.map

package/dist/src/package-json.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"package-json.d.ts","sourceRoot":"","sources":["../../src/package-json.js"],"names":[],"mappings":"AAUO,qFA0EN"}
+{"version":3,"file":"package-json.d.ts","sourceRoot":"","sources":["../../src/package-json.js"],"names":[],"mappings":"AAOA;;GAEG;AACH,qFA0EC"}

package/dist/src/prettier.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Turns off all rules that are unnecessary or might conflict with Prettier.
+ *
+ * Notice that this config does not run `prettier` as an ESLint rule, so you
+ * have to run `pretter` separately for formatting.
+ */
 export function prettier(): import("eslint-define-config").FlatESLintConfigItem[];
 //# sourceMappingURL=prettier.d.ts.map

package/dist/src/prettier.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prettier.d.ts","sourceRoot":"","sources":["../../src/prettier.js"],"names":[],"mappings":"AAQO,kFAWN"}
+{"version":3,"file":"prettier.d.ts","sourceRoot":"","sources":["../../src/prettier.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,kFAWC"}

package/dist/src/react.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/react.js"],"names":[],"mappings":"AASO,+EAwCN"}
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../../src/react.js"],"names":[],"mappings":"AASA,+EAwCC"}

package/dist/src/typescript.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @typedef {Object} TypescriptOptions
+ * @property {string | false} [project] - Path to tsconfig.json, defaults
+ * to './tsconfig.json'. You can pass `false` to disable the tsconfig.json check.
+ */
+/**
+ * @param {TypescriptOptions} [options]
+ */
 export function typescript(options?: TypescriptOptions | undefined): import("eslint-define-config").FlatESLintConfigItem[];
 export type TypescriptOptions = {
     /**

package/dist/src/typescript.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/typescript.js"],"names":[],"mappings":"AAkBO,2HAsEN;;;;;;;;qBArFoB,2BAA2B;qBAD3B,kCAAkC"}
+{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/typescript.js"],"names":[],"mappings":"AASA;;;;GAIG;AAEH;;GAEG;AACH,2HAsEC;;;;;;;;qBArFoB,2BAA2B;qBAD3B,kCAAkC"}

package/dist/src/unicorn.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unicorn.d.ts","sourceRoot":"","sources":["../../src/unicorn.js"],"names":[],"mappings":"AAKO,iFA+DN"}
+{"version":3,"file":"unicorn.d.ts","sourceRoot":"","sources":["../../src/unicorn.js"],"names":[],"mappings":"AAKA,iFA+DC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocavue/eslint-config",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "packageManager": "pnpm@8.5.1",
   "description": "",
   "author": "ocavue <ocavue@gmail.com>",
@@ -37,6 +37,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-define-config": "^1.20.0",
     "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-antfu": "^0.39.3",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsonc": "^2.8.0",
     "eslint-plugin-markdown": "^3.0.0",

package/src/antfu.js

@@ -0,0 +1,17 @@
+import antfuPlugin from 'eslint-plugin-antfu'
+
+export function antfu() {
+  /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
+  const config = [
+    {
+      plugins: {
+        antfu: antfuPlugin,
+      },
+      rules: {
+        'antfu/top-level-function': 'error',
+      },
+    },
+  ]
+
+  return config
+}

package/src/basic.js

@@ -1,5 +1,6 @@
 // @ts-check
 
+import { antfu } from './antfu.js'
 import { imports } from './imports.js'
 import { noOnlyTests } from './no-only-tests.js'
 import { packageJson } from './package-json.js'
@@ -16,7 +17,7 @@ import { unicorn } from './unicorn.js'
 /**
  * @param {BasicOptions} [options]
  */
-export const basic = (options) => {
+export function basic(options) {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {
@@ -27,6 +28,7 @@ export const basic = (options) => {
     ...imports(),
     ...packageJson(),
     ...unicorn(),
+    ...antfu(),
     ...noOnlyTests(),
     ...prettier(),
   ]

package/src/imports.js

@@ -3,7 +3,7 @@
 // @ts-expect-error no type
 import importPlugin from 'eslint-plugin-import'
 
-export const imports = () => {
+export function imports() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/markdown.js

@@ -5,7 +5,7 @@ import markdownPlugin from 'eslint-plugin-markdown'
 
 import { GLOB_MARKDOWN, GLOB_SRC, GLOB_VUE } from './shared.js'
 
-export const markdown = () => {
+export function markdown() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/no-only-tests.js

@@ -3,7 +3,7 @@
 // @ts-expect-error: eslint-plugin-unicorn is not typed
 import plugin from 'eslint-plugin-no-only-tests'
 
-export const noOnlyTests = () => {
+export function noOnlyTests() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/package-json.js

@@ -8,7 +8,7 @@ import { GLOB_PACKAGE_JSON } from './shared.js'
 /**
  * Sort package.json keys
  */
-export const packageJson = () => {
+export function packageJson() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/prettier.js

@@ -6,7 +6,7 @@ import prettierConfig from 'eslint-config-prettier'
  * Notice that this config does not run `prettier` as an ESLint rule, so you
  * have to run `pretter` separately for formatting.
  */
-export const prettier = () => {
+export function prettier() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/react.js

@@ -7,7 +7,7 @@ import reactHooksPlugin from 'eslint-plugin-react-hooks'
 
 import { GLOB_TSX } from './shared.js'
 
-export const react = () => {
+export function react() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {

package/src/typescript.js

@@ -16,7 +16,7 @@ export { tsParser, tsPlugin }
 /**
  * @param {TypescriptOptions} [options]
  */
-export const typescript = (options) => {
+export function typescript(options) {
   const project = options?.project ?? './tsconfig.json'
 
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */

package/src/unicorn.js

@@ -3,7 +3,7 @@
 // @ts-expect-error: eslint-plugin-unicorn is not typed
 import plugin from 'eslint-plugin-unicorn'
 
-export const unicorn = () => {
+export function unicorn() {
   /** @type {import('eslint-define-config').FlatESLintConfigItem[]} */
   const config = [
     {