switch to a tsc and tsx based setup with support for NodeNext m…

…odule resolution. (#41)

.changeset/brave-dryers-sin.md

@@ -0,0 +1,5 @@
+---
+"@effect/docgen": minor
+---
+
+Modernized and switched to a `tsc` and `tsx` based setup with support for `NodeNext` module resolution.

.eslintrc.cjs

@@ -1,11 +1,10 @@
 /* eslint-disable no-undef */
 module.exports = {
-  ignorePatterns: ["build", "dist", "dtslint", "*.mjs", "docs", "*.md"],
+  ignorePatterns: ["dist", "*.mjs", "docs", "*.md"],
   parser: "@typescript-eslint/parser",
   parserOptions: {
     ecmaVersion: 2018,
-    sourceType: "module",
-    project: "./tsconfig.eslint.json"
+    sourceType: "module"
   },
   settings: {
     "import/parsers": {
@@ -44,7 +43,6 @@ module.exports = {
     "sort-destructure-keys/sort-destructure-keys": "error",
     "deprecation/deprecation": "off",
     "@typescript-eslint/array-type": ["warn", { "default": "generic", "readonly": "generic" }],
-    "@typescript-eslint/prefer-readonly": "warn",
     "@typescript-eslint/member-delimiter-style": 0,
     "@typescript-eslint/no-non-null-assertion": "off",
     "@typescript-eslint/ban-types": "off",

.github/workflows/main.yml

@@ -10,47 +10,30 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-
     strategy:
       matrix:
-        node-version: [16.17.1]
+        node-version: [20.9.0]
 
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+      - uses: pnpm/action-setup@v2
+        name: Install pnpm
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
+          cache: pnpm
           node-version: ${{ matrix.node-version }}
-      - uses: pnpm/[email protected]
-        name: Install pnpm
-        id: pnpm-install
-        with:
-          version: 8
-          run_install: false
-      - name: Get pnpm store directory
-        id: pnpm-cache
-        run: |
-          echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"
-      - uses: actions/cache@v3
-        name: Setup pnpm cache
-        with:
-          path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
       - run: pnpm install
       - run: pnpm build
       - run: pnpm test
       - run: pnpm lint
-      - run: pnpm run docs
+      - run: pnpm docgen
       - name: Create Release Pull Request or Publish
         id: changesets
         uses: changesets/action@v1
         with:
-          version: pnpm run version
-          publish: pnpm exec changeset publish
+          version: pnpm update-version
+          publish: pnpm changeset publish
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/pr.yml

@@ -11,38 +11,21 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-
     strategy:
       matrix:
-        node-version: [16.17.1]
+        node-version: [20.9.0]
 
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+      - uses: pnpm/action-setup@v2
+        name: Install pnpm
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
+          cache: pnpm
           node-version: ${{ matrix.node-version }}
-      - uses: pnpm/[email protected]
-        name: Install pnpm
-        id: pnpm-install
-        with:
-          version: 8
-          run_install: false
-      - name: Get pnpm store directory
-        id: pnpm-cache
-        run: |
-          echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"
-      - uses: actions/cache@v3
-        name: Setup pnpm cache
-        with:
-          path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
-          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-pnpm-store-
       - run: pnpm install
       - run: pnpm build
       - run: pnpm test
       - run: pnpm lint
-      - run: pnpm run docs
+      - run: pnpm docgen

.gitignore

@@ -1,10 +1,7 @@
 coverage/
 *.tsbuildinfo
 node_modules/
-yarn-error.log
-.ultra.cache.json
 .DS_Store
 tmp/
-build/
 dist/
 .direnv/

README.md

@@ -42,29 +42,38 @@ The `docgen.json` configuration file allows you to customize `docgen`'s behavior
 ```json
 {
   "exclude": ["src/internal/**/*.ts"],
-  "theme": "mikearnaldi/just-the-docs",
   "parseCompilerOptions": {
-    "strict": true,
     "noEmit": true,
-    "target": "ES2021",
-    "lib": ["ES2021"],
+    "strict": true,
+    "skipLibCheck": true,
+    "moduleResolution": "Bundler",
+    "target": "ES2022",
+    "lib": [
+      "ES2022",
+      "DOM"
+    ],
     "paths": {
-      "@effect/<project-name>": ["./src/index.ts"],
-      "@effect/<project-name>/test/*": ["./test/*"],
-      "@effect/<project-name>/examples/*": ["./examples/*"],
-      "@effect/<project-name>/*": ["./src/*"]
+      "@effect/<project-name>": ["./src/index.js"],
+      "@effect/<project-name>/test/*": ["./test/*.js"],
+      "@effect/<project-name>/examples/*": ["./examples/*.js"],
+      "@effect/<project-name>/*": ["./src/*.js"]
     }
   },
   "examplesCompilerOptions": {
-    "strict": true,
     "noEmit": true,
-    "target": "ES2021",
-    "lib": ["ES2021"],
+    "strict": true,
+    "skipLibCheck": true,
+    "moduleResolution": "Bundler",
+    "target": "ES2022",
+    "lib": [
+      "ES2022",
+      "DOM"
+    ],
     "paths": {
-      "@effect/<project-name>": ["../../src/index.ts"],
-      "@effect/<project-name>/test/*": ["../../test/*"],
-      "@effect/<project-name>/examples/*": ["../../examples/*"],
-      "@effect/<project-name>/*": ["../../src/*"]
+      "@effect/<project-name>": ["../../src/index.js"],
+      "@effect/<project-name>/test/*": ["../../test/*.js"],
+      "@effect/<project-name>/examples/*": ["../../examples/*.js"],
+      "@effect/<project-name>/*": ["../../src/*.js"]
     }
   }
 }

docgen.json

@@ -1,5 +1,16 @@
 {
-  "$schema": "dist/schema.json",
-  "parseCompilerOptions": "./tsconfig.json",
-  "examplesCompilerOptions": "./tsconfig.examples.json"
+  "$schema": "./schema.json",
+  "exclude": ["bin.ts"],
+  "parseCompilerOptions": {
+    "noEmit": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "exactOptionalPropertyTypes": true,
+    "moduleResolution": "Bundler",
+    "target": "ES2022",
+    "lib": [
+      "ES2022",
+      "DOM"
+    ]
+  }
 }

docs/_config.yml

@@ -5,5 +5,5 @@ search_enabled: true
 
 # Aux links for the upper right navigation
 aux_links:
-'@effect/docgen on GitHub':
-  - 'https://github.com/effect-ts/docgen'
+  '@effect/docgen on GitHub':
+    - 'https://github.com/effect-ts/docgen'

docs/modules/Config.ts.md

@@ -28,7 +28,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const ConfigLive: Layer.Layer<Process.Process | FileSystem.FileSystem, Error, Config>
+export declare const ConfigLive: Layer.Layer<Process.Process | Path.Path | FileSystem.FileSystem, Error, Config>
 ```
 
 Added in v1.0.0

docs/modules/Domain.ts.md

@@ -208,7 +208,7 @@ Added in v1.0.0
 
 ```ts
 export interface Class extends NamedDoc {
-  readonly _tag: 'Class'
+  readonly _tag: "Class"
   readonly signature: string
   readonly methods: ReadonlyArray<Method>
   readonly staticMethods: ReadonlyArray<Method>
@@ -224,7 +224,7 @@ Added in v1.0.0
 
 ```ts
 export interface Constant extends NamedDoc {
-  readonly _tag: 'Constant'
+  readonly _tag: "Constant"
   readonly signature: string
 }
 ```
@@ -273,7 +273,7 @@ export {
 
 ```ts
 export interface Export extends NamedDoc {
-  readonly _tag: 'Export'
+  readonly _tag: "Export"
   readonly signature: string
 }
 ```
@@ -286,7 +286,7 @@ Added in v1.0.0
 
 ```ts
 export interface Function extends NamedDoc {
-  readonly _tag: 'Function'
+  readonly _tag: "Function"
   readonly signatures: ReadonlyArray<string>
 }
 ```
@@ -299,7 +299,7 @@ Added in v1.0.0
 
 ```ts
 export interface Interface extends NamedDoc {
-  readonly _tag: 'Interface'
+  readonly _tag: "Interface"
   readonly signature: string
 }
 ```
@@ -355,7 +355,7 @@ Added in v1.0.0
 
 ```ts
 export interface Namespace extends NamedDoc {
-  readonly _tag: 'Namespace'
+  readonly _tag: "Namespace"
   readonly interfaces: ReadonlyArray<Interface>
   readonly typeAliases: ReadonlyArray<TypeAlias>
   readonly namespaces: ReadonlyArray<Namespace>
@@ -382,7 +382,7 @@ Added in v1.0.0
 
 ```ts
 export interface TypeAlias extends NamedDoc {
-  readonly _tag: 'TypeAlias'
+  readonly _tag: "TypeAlias"
   readonly signature: string
 }
 ```

docs/modules/Markdown.ts.md

@@ -24,18 +24,18 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const printModule: (module: Domain.Module, order: number) => string
+export declare const printModule: (module: Domain.Module, order: number) => Effect.Effect<never, never, string>
 ```
 
 **Example**
 
 ```ts
-import * as Markdown from '@effect/docgen/Markdown'
-import * as Domain from '@effect/docgen/Domain'
-import { Option } from 'effect'
+import * as Markdown from "@effect/docgen/Markdown"
+import * as Domain from "@effect/docgen/Domain"
+import { Option } from "effect"
 
-const doc = Domain.createNamedDoc('tests', Option.none(), Option.some('1.0.0'), false, [], Option.none())
-const m = Domain.createModule(doc, ['src', 'tests.ts'], [], [], [], [], [], [], [])
+const doc = Domain.createNamedDoc("tests", Option.none(), Option.some("1.0.0"), false, [], Option.none())
+const m = Domain.createModule(doc, ["src", "tests.ts"], [], [], [], [], [], [], [])
 console.log(Markdown.printModule(m, 0))
 ```
 

docs/modules/Parser.ts.md

@@ -64,7 +64,7 @@ Added in v1.0.0
 ```ts
 export declare const parseFiles: (
   files: ReadonlyArray<FileSystem.File>
-) => Effect.Effect<Process.Process | Config.Config, string[][], Domain.Module[]>
+) => Effect.Effect<Process.Process | Config.Config | Path.Path, string[][], Domain.Module[]>
 ```
 
 Added in v1.0.0
@@ -94,7 +94,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const parseModule: Effect.Effect<Config.Config | Source, string[], Domain.Module>
+export declare const parseModule: Effect.Effect<Config.Config | Path.Path | Source, string[], Domain.Module>
 ```
 
 Added in v1.0.0

flake.nix

@@ -17,14 +17,18 @@
   }:
     flake-utils.lib.eachDefaultSystem (system: let
       pkgs = nixpkgs.legacyPackages.${system};
+      corepackEnable = pkgs.runCommand "corepack-enable" {} ''
+        mkdir -p $out/bin
+        ${pkgs.nodejs_20}/bin/corepack enable --install-directory $out/bin
+      '';
     in {
       formatter = pkgs.alejandra;
 
       devShells = {
         default = pkgs.mkShell {
           buildInputs = with pkgs; [
-            nodejs-18_x
-            nodePackages.pnpm
+            nodejs_20
+            corepackEnable
           ];
         };
       };