chore: split lint/format processes as recommended by both software

Author: brianrodri

.github/workflows/ci.yml

@@ -2,26 +2,26 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: latest
-      - name: Install dependencies
-        run: npm clean-install
-        env:
-          HUSKY: 0
-      - name: Audit dependencies
-        run: npm audit && npm audit signatures
-      - name: Audit code coverage
-        run: npm run coverage
-      - name: Upload coverage reports to Codecov
-        uses: codecov/[email protected]
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          slug: brianrodri/objo
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: latest
+            - name: Install dependencies
+              run: npm clean-install
+              env:
+                  HUSKY: 0
+            - name: Audit dependencies
+              run: npm audit && npm audit signatures
+            - name: Audit code coverage
+              run: npm run coverage
+            - name: Upload coverage reports to Codecov
+              uses: codecov/[email protected]
+              with:
+                  token: ${{ secrets.CODECOV_TOKEN }}
+                  slug: brianrodri/objo

.github/workflows/release.yml

@@ -2,35 +2,35 @@ name: Release
 on: workflow_dispatch
 
 permissions:
-  contents: read # for checkout
+    contents: read # for checkout
 
 jobs:
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write # to be able to publish a GitHub release
-      issues: write # to be able to comment on released issues
-      pull-requests: write # to be able to comment on released pull requests
-      id-token: write # to enable use of OIDC for npm provenance
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: latest
-      - name: Install dependencies
-        run: npm clean-install
-        env:
-          HUSKY: 0
-      - name: Audit dependencies
-        run: npm audit && npm audit signatures
-      - name: Audit code coverage
-        run: npm run coverage
-      - name: Build plugin
-        run: npm run build
-      - name: Release update
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release
+    release:
+        name: Release
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write # to be able to publish a GitHub release
+            issues: write # to be able to comment on released issues
+            pull-requests: write # to be able to comment on released pull requests
+            id-token: write # to enable use of OIDC for npm provenance
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: latest
+            - name: Install dependencies
+              run: npm clean-install
+              env:
+                  HUSKY: 0
+            - name: Audit dependencies
+              run: npm audit && npm audit signatures
+            - name: Audit code coverage
+              run: npm run coverage
+            - name: Build plugin
+              run: npm run build
+            - name: Release update
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: npx semantic-release

.husky/pre-commit

@@ -1 +1,2 @@
+npm run format
 npm run lint

.prettierignore

@@ -0,0 +1,5 @@
+coverage/
+docs/
+dist/
+node_modules/
+test-vault/

eslint.config.js

@@ -1,14 +1,13 @@
 import { FlatCompat } from "@eslint/eslintrc";
-import eslintJs from "@eslint/js";
-import typescriptPlugin from "@typescript-eslint/eslint-plugin";
-import typescriptPluginParser from "@typescript-eslint/parser";
-import prettierConfig from "eslint-config-prettier";
 import boundaries from "eslint-plugin-boundaries";
-import prettierPlugin from "eslint-plugin-prettier";
-import reactHooksPlugin from "eslint-plugin-react-hooks";
-import globals from "globals";
 import { dirname } from "path";
+import eslintConfigPrettier from "eslint-config-prettier";
+import eslintJs from "@eslint/js";
 import { fileURLToPath } from "url";
+import globals from "globals";
+import reactHooksPlugin from "eslint-plugin-react-hooks";
+import typescriptPlugin from "@typescript-eslint/eslint-plugin";
+import typescriptPluginParser from "@typescript-eslint/parser";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -27,6 +26,7 @@ export default [
 
     {
         files: ["*.config.js"],
+        rules: { "sort-imports": ["error"] },
         languageOptions: { globals: { ...globals.node } },
     },
 
@@ -40,6 +40,7 @@ export default [
             ...typescriptPlugin.configs.recommended.rules,
             ...typescriptPlugin.configs.strict.rules,
             ...reactHooksPlugin.configs.recommended.rules,
+            "sort-imports": ["error"],
         },
         languageOptions: {
             globals: { ...globals.browser },
@@ -48,13 +49,7 @@ export default [
         },
     },
 
-    {
-        plugins: { prettier: prettierPlugin },
-        rules: {
-            ...prettierConfig.rules,
-            "prettier/prettier": "error",
-        },
-    },
+    eslintConfigPrettier,
 
     {
         files: ["src/**/*"],

package-lock.json

@@ -11,6 +11,7 @@
         "commitlint": "commitlint --edit",
         "docs": "typedoc src/main.tsx --plugin typedoc-plugin-coverage --out docs/ --excludeExternals --excludePrivate --excludeProtected",
         "hotreload": "git submodule init && git submodule update && vite build --mode development --outDir ./test-vault/.obsidian/plugins/objo/ --watch",
+        "format": "prettier --write .",
         "lint": "eslint .",
         "prepare": "husky",
         "test": "vitest run",
@@ -52,6 +53,7 @@
         "husky": "latest",
         "jsdom": "latest",
         "obsidian": "latest",
+        "prettier": "latest",
         "semantic-release": "latest",
         "semantic-release-obsidian-plugin": "latest",
         "tslib": "latest",

package.json

@@ -6,7 +6,4 @@ export default {
     semi: true,
     useTabs: false,
     experimentalTernaries: true,
-    importOrder: ["^[./]"],
-    importOrderSeparation: true,
-    importOrderSortSpecifiers: true,
 };

prettier.config.js

@@ -1,6 +1,5 @@
-import { DateTime } from "luxon";
-
 import { DataSource } from "@/data/data-source";
+import { DateTime } from "luxon";
 
 export interface Task {
     status: TaskStatus;

src/data/task.ts

@@ -1,6 +1,6 @@
-import { Task } from "@/data/task";
 import { DataviewApi, getAPI, isPluginEnabled } from "@/lib/obsidian-dataview/types";
 import { Plugin } from "@/lib/obsidian/types";
+import { Task } from "@/data/task";
 import { mergeTasks } from "@/utils/merge-tasks";
 import { parseEmojis } from "@/utils/parse-emojis";
 

src/lib/obsidian-dataview/adapter.ts

@@ -1,6 +1,6 @@
+import type { SMarkdownPage, STask } from "obsidian-dataview/lib/data-model/serialized/markdown";
 export { DataviewApi, getAPI, isPluginEnabled } from "obsidian-dataview";
 import { DateTime } from "luxon";
-import type { SMarkdownPage, STask } from "obsidian-dataview/lib/data-model/serialized/markdown";
 
 export type Page = SMarkdownPage;
 

src/lib/obsidian-dataview/types.ts

@@ -1,5 +1,5 @@
-import { Plugin } from "@/lib/obsidian/types";
 import { Dataview } from "@/lib/obsidian-dataview/adapter";
+import { Plugin } from "@/lib/obsidian/types";
 
 export class Objo extends Plugin {
     override onload() {

src/main.tsx

@@ -1,6 +1,5 @@
-import { DateTime } from "luxon";
 import { describe, expect, it } from "vitest";
-
+import { DateTime } from "luxon";
 import { mergeTasks } from "../merge-tasks";
 
 describe("Merging tasks", () => {

src/utils/__tests__/merge-tasks.ts

@@ -1,6 +1,5 @@
-import { DateTime } from "luxon";
 import { describe, expect, it } from "vitest";
-
+import { DateTime } from "luxon";
 import { parseEmojis } from "../parse-emojis";
 
 describe("Parsing emojis", () => {

src/utils/__tests__/parse-emojis.ts

@@ -1,9 +1,8 @@
 /* v8 ignore next 2 */
 // TODO: Why does v8 consider this line to be untested?
-import { isNumber, isSet, isString, mergeWith, MergeWithCustomizer } from "lodash";
+import { MergeWithCustomizer, isNumber, isSet, isString, mergeWith } from "lodash";
 import { DateTime } from "luxon";
 import { DeepPartial } from "utility-types";
-
 import { Task } from "@/data/task";
 
 const DEFAULT_TYPE_VALUE = "UNKNOWN" as const;

src/utils/merge-tasks.ts

@@ -1,7 +1,6 @@
-import { Dictionary, set } from "lodash";
 import { DateTime, Interval } from "luxon";
+import { Dictionary, set } from "lodash";
 import { DeepPartial } from "utility-types";
-
 import { Task } from "@/data/task";
 
 export function parseEmojis(text: string): DeepPartial<Task> {

src/utils/parse-emojis.ts

@@ -1,6 +1,6 @@
+import { defineConfig } from "vite";
 import preact from "@preact/preset-vite";
 import { resolve } from "path";
-import { defineConfig } from "vite";
 import { viteStaticCopy } from "vite-plugin-static-copy";
 
 export default defineConfig(({ mode }) => ({