feat: add recommended config (#1)

Also, setup vitest and esbuild, along with some tests.

.projenrc.js

@@ -5,22 +5,12 @@ const project = new typescript.TypeScriptProject({
   name: "@cloudy-ts/eslint-plugin",
 
   deps: [],
-  devDeps: [
-    "eslint",
-    "@types/eslint",
-    "esbuild",
-    "rollup",
-    "rollup-plugin-esbuild",
-    "rollup-plugin-dts",
-    "@rollup/plugin-node-resolve",
-    "@rollup/plugin-commonjs",
-    "@rollup/plugin-json",
-    "@rollup/plugin-alias",
-  ],
   peerDeps: ["eslint"],
+  devDeps: ["eslint", "@types/eslint"],
 
-  prettier: true,
-
+  // ESM.
+  entrypoint: "lib/index.cjs",
+  entrypointTypes: "",
   tsconfig: {
     compilerOptions: {
       lib: ["ES2020"],
@@ -31,24 +21,48 @@ const project = new typescript.TypeScriptProject({
     },
   },
 
-  minNodeVersion: "14.18.0",
+  // Lint.
+  prettier: true,
+
+  // Test.
+  jest: false,
 
   releaseToNpm: true,
   npmAccess: javascript.NpmAccess.PUBLIC,
+  minNodeVersion: "14.18.0",
 });
 
+// ESM.
 project.addFields({
   type: "module",
   exports: {
     ".": {
+      require: "./lib/index.cjs",
       import: `./lib/index.js`,
-      types: "./lib/index.d.ts",
     },
   },
 });
 
-// project.compileTask.exec("rollup -c");
-// project.watchTask.prependExec("rollup -c --watch");
-// project.addTask("dev", { exec: "rollup -c --watch" });
+// Build.
+project.addDevDeps("esbuild");
+project.compileTask.reset();
+project.compileTask.prependExec(
+  "esbuild src/index.ts --bundle --target=es2020 --platform=node --format=esm --outfile=lib/index.js"
+);
+project.compileTask.prependExec(
+  "esbuild src/index.ts --bundle --target=es2020 --platform=node --format=cjs --outfile=lib/index.cjs"
+);
+
+// Test.
+project.addDevDeps("vitest", "c8");
+project.testTask.exec("vitest test/rules --passWithNoTests --coverage --run");
+
+project.compileTask.prependExec(
+  "yarn link && cd ./test/test-app && yarn && yarn link @cloudy-ts/eslint-plugin"
+);
+project.testTask.exec("vitest test/test-app/index.test.ts --run");
+
+project.watchTask.reset();
+project.watchTask.exec("vitest test/rules --passWithNoTests --coverage");
 
 project.synth();

README.md

@@ -1 +1,40 @@
-# replace this
+# @cloudy-ts/eslint-plugin
+
+ESLint plugin that provides a rule to enforce explicit `.js` or `.json` extensions on imports.
+
+[![NPM version](https://img.shields.io/npm/v/@cloudy-ts/eslint-plugin/latest.svg)](https://www.npmjs.com/package/@cloudy-ts/eslint-plugin)
+[![NPM downloads](https://img.shields.io/npm/dm/@cloudy-ts/eslint-plugin.svg)](https://www.npmjs.com/package/@cloudy-ts/eslint-plugin)
+[![Build status](https://img.shields.io/github/workflow/status/skyrpex/cloudy-ts-eslint-plugin/release)](https://www.npmjs.com/package/@cloudy-ts/eslint-plugin)
+
+## Installation
+
+```sh
+yarn add @cloudy-ts/eslint-plugin -D
+```
+
+## Usage
+
+Extend from the recommended configuration in your ESLint configuration file (ie, in your `package.json` file):
+
+```json
+{
+  "name": "my-awesome-project",
+  "eslintConfig": {
+    "extends": "plugin:@cloudy-ts/recommended"
+  }
+}
+```
+
+## Rules
+
+Each rule has emojis denoting:
+
+- ✅ if it belongs to the `recommended` configuration
+- 🔧 if some problems reported by the rule are automatically fixable by the `--fix` [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) option
+- 💡 if some problems reported by the rule are manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+| Name                                         | Description                                | ✅  | 🔧  | 💡  |
+| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------- | :-- | :-- | :-- |
+| [extensions](docs/rules/extensions.md)                                                                                                                                                                                                               | Enforce import and export file extensions. | ✅  | 🔧  | 💡  |
+
+## Motivation

docs/rules/extensions.md

@@ -0,0 +1,21 @@
+# Enforce import and export file extensions
+
+In ESM, import paths and export paths must contain the file extension in it. This rule suggests and fixes the imports for you.
+
+## Fail
+
+```js
+import { add } from "./math";
+
+import { add } from "./math.ts";
+
+import pkg from "./package";
+```
+
+## Pass
+
+```js
+import { add } from "./math.js";
+
+import pkg from "./package.json";
+```