refactor!(secretlint): convert to ESM - top down

[azu]

Convert each packages to Pure ESM.

• fix Core Packags: Convert to ESM #527
• close WIP: Convert to ESM - bottom up #528
  • Is is bottom up approach, this PR is top down approch
  • same purpose, but different way

Approach

• Target: secretlint packages
• Non Target: secretlint rule package

Apply Top Down Approach.

Get dependency graph via Explore the Project Graph.

npx nx graph

1. @secretlint/quick-start
2. secretlint
3. node/tester
4. formatter/node/config-creator/messages-to-markdown/config-loader/core
5. types/profile

@secretlint/types should be dual package.
Because, CJS can not load types of ESM packages.

// if @secretlint/types is pure ESM, can not load it from CommonJS
import type { SecretLintRuleMessageTranslate } from "@secretlint/types";

By making @secretlint/types a dual package, the types can be used from both CJS and ESM.

Changes

• Convert to Pure ESM package
  • If your scripts are CommonJS, you need to dynamic import import("@secretlint/core").
  • For command line/Docker user, No change anything!
• Convert @secretlint/types to dual package
  • Dual CommonJS/ES module packages
  • You can import @secretlint/types from both CJS and ESM.
• Add new "json" formatter for secretlint
  • output format is changed from old "json" formatter
• @secretlint/tester is migrated to ESM, But we can load it using dynamic import from CJS
  • Use node:test instead of Mocha
  • Support URL object in snapshotDirectory option.

- import { snapshot } from "@secretlint/tester");
import path from "path";
import { creator as rule } from "../src/index";
+ import test from "node:test";
+ (async function () {
+   const snapshot = (await import("@secretlint/tester")).snapshot;
-    describe("@secretlint/secretlint-rule-preset-canary", () => {
+    test("@secretlint/secretlint-rule-preset-canary", async (t) => {
-        snapshot({
+        return snapshot({
            defaultConfig: {
                rules: [
                    {
                        id: "@secretlint/secretlint-rule-preset-canary",
                        rule,
                        rules: [],
                        options: {},
                    },
                ],
            },
            updateSnapshot: !!process.env.UPDATE_SNAPSHOT,
            snapshotDirectory: path.join(__dirname, "snapshots"),
        }).forEach((name, test) => {
-            it(name, async function () {
+            return it(name, async (context) => {
                const status = await test();
                if (status === "skip") {
-                    this.skip();
+                    context.skip();
                }
            });
        });
    });
+});

Not Changes

• Each rules are written as CommonJS
• It will be separated PRs.