Add an initializer package for quickly creating a new EdgeDB project

.github/workflows/release.yml

@@ -389,3 +389,62 @@ jobs:
           body: ${{steps.github_auth_remix_release.outputs.changelog}}
           draft: true
           prerelease: false
+
+      # @edgedb/create
+
+      - name: Build @edgedb/create
+        run: yarn workspace @edgedb/create run build
+
+      - id: check_publish_create
+        name: Dry-run publish '@edgedb/create' to npm
+        uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552
+        with:
+          package: packages/create/package.json
+          token: ${{ secrets.NPM_TOKEN }}
+          dry-run: true
+
+      - name: If '@edgedb/create' version unchanged
+        if: steps.check_publish_create.outputs.type == ''
+        run: |
+          echo "Version in package.json has not changed. Creating canary release."
+          yarn workspace @edgedb/create version  --no-git-tag-version --minor
+          CURRENT_VERSION=$(node -p "require('./packages/create/package.json').version")
+          yarn workspace @edgedb/create version --no-git-tag-version --new-version "${CURRENT_VERSION}-canary.$(date +'%Y%m%dT%H%M%S')"
+
+      - name: Publish '@edgedb/create'
+        uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552
+        with:
+          package: packages/create/package.json
+          token: ${{ secrets.NPM_TOKEN }}
+          access: public
+          tag: ${{ steps.check_publish_create.outputs.type == '' && 'canary' || 'latest' }}
+
+      - name: Build '@edgedb/create' Changelog
+        if: steps.check_publish_create.outputs.type != ''
+        id: github_create_release
+        uses: mikepenz/release-changelog-builder-action@v3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          fromTag: "${{ env.last_tag }}"
+          toTag: ${{ github.ref }}
+          commitMode: true
+          configurationJson: |
+            {
+              "template": "## Commits:\n\n#{{UNCATEGORIZED}}",
+              "pr_template": "- #{{MERGE_SHA}} #{{TITLE}}",
+              "categories": []
+            }
+
+      - name: Create '@edgedb/create' Release
+        if: steps.check_publish_create.outputs.type != ''
+        uses: actions/create-release@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: create-v${{ steps.check_publish_create.outputs.version }}
+          release_name: \@edgedb/create v${{ steps.check_publish_create.outputs.version }}
+          commitish: ${{ github.ref }}
+          body: ${{steps.github_create_release.outputs.changelog}}
+          draft: true
+          prerelease: false

packages/create/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@edgedb/create",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Create a new EdgeDB-based project",
+  "homepage": "https://edgedb.com/docs",
+  "author": "EdgeDB <[email protected]>",
+  "engines": {
+    "node": ">= 18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/edgedb/edgedb-js.git"
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "files": [
+    "/dist"
+  ],
+  "bin":  "dist/cli.js",
+  "peerDependencies": {},
+  "devDependencies": {
+    "@types/debug": "^4.1.12",
+    "@types/node": "^20.10.4",
+    "tsx": "^4.6.2",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.7.0",
+    "debug": "^4.3.4",
+    "read-pkg": "^9.0.1",
+    "write-package": "^7.0.0"
+  },
+  "scripts": {
+    "create": "tsx src/cli.ts",
+    "build": "tsc"
+  }
+}

packages/create/src/cli.ts

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+
+import * as p from "@clack/prompts";
+import process from "node:process";
+import path from "node:path";
+import debug from "debug";
+
+import * as utils from "./utils.js";
+import { recipes, type Framework } from "./recipes/index.js";
+
+const logger = debug("@edgedb/create:main");
+
+async function main() {
+  const packageManager = utils.getPackageManager();
+  logger({ packageManager });
+
+  const setup = await p.group(
+    {
+      projectName: () =>
+        p.text({
+          message: "What is the name of your project or application?",
+        }),
+      framework: () =>
+        p.select<{ value: Framework; label: string }[], Framework>({
+          message: "What web framework should be used?",
+          options: [
+            { value: "next", label: "Next.js" },
+            { value: "remix", label: "Remix" },
+            { value: "express", label: "Express" },
+            { value: "node-http", label: "Node HTTP Server" },
+            { value: "none", label: "None" },
+          ],
+        }),
+      useEdgeDBAuth: () =>
+        p.confirm({
+          message: "Use the EdgeDB Auth extension?",
+          initialValue: true,
+        }),
+      shouldGitInit: () =>
+        p.confirm({
+          message: "Initialize a git repository and stage changes?",
+          initialValue: true,
+        }),
+      shouldInstall: () =>
+        p.confirm({
+          message: `Install dependencies with ${packageManager}?`,
+          initialValue: true,
+        }),
+    },
+    {
+      onCancel: () => {
+        process.exit(1);
+      },
+    }
+  );
+
+  logger(setup);
+
+  for (const recipe of recipes) {
+    await recipe({
+      ...setup,
+      projectDir: path.resolve(process.cwd(), setup.projectName),
+    });
+  }
+}
+
+await main();

packages/create/src/recipes/base/_eslint.config.js

@@ -0,0 +1,24 @@
+import { FlatCompat } from "@eslint/eslintrc";
+import js from "@eslint/js";
+
+const compat = new FlatCompat();
+
+export default [
+  {
+    ...compat
+      .extends(
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended-type-checked",
+        "plugin:@typescript-eslint/stylistic-type-checked",
+        "prettier"
+      )
+      .map((c) => ({
+        ...c,
+        files: ["**/*.{ts,tsx,mts}"],
+      })),
+  },
+  {
+    files: ["**/*.{js,jsx,cjs,mjs}"],
+    ...js.configs.recommended,
+  },
+];

packages/create/src/recipes/base/_package.json

@@ -0,0 +1,19 @@
+{
+  "name": "replace-me",
+  "version": "0.1.0",
+  "type": "module",
+  "private": true,
+  "dependencies": {
+    "edgedb": "1.x"
+  },
+  "devDependencies": {
+    "@edgedb/generate": "1.x",
+    "@typescript-eslint/eslint-plugin": "6.x",
+    "@typescript-eslint/parser": "6.x",
+    "@eslint/eslintrc": "2.x",
+    "eslint": "8.x",
+    "eslint-config-prettier": "9.x",
+    "prettier": "3.x",
+    "typescript": "5.x"
+  }
+}

packages/create/src/recipes/base/_tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "node16" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}

packages/create/src/recipes/base/index.ts

@@ -0,0 +1,63 @@
+import debug from "debug";
+import fs from "node:fs/promises";
+import path from "node:path";
+import { readPackage } from "read-pkg";
+import { writePackage } from "write-package";
+import type { RecipeOptions } from "../types.js";
+
+const logger = debug("@edgedb/create:recipe:base");
+
+export default async function BaseRecipe({
+  projectDir,
+  projectName,
+}: RecipeOptions) {
+  logger("Running base recipe");
+  try {
+    const projectDirStat = await fs.stat(projectDir);
+    logger({ projectDirStat });
+
+    if (!projectDirStat.isDirectory()) {
+      throw new Error(
+        `Target project directory ${projectDir} is not a directory`
+      );
+    }
+    const files = await fs.readdir(projectDir);
+    if (files.length > 0) {
+      throw new Error(`Target project directory ${projectDir} is not empty`);
+    }
+  } catch (err) {
+    if (
+      typeof err === "object" &&
+      err !== null &&
+      "code" in err &&
+      err.code === "ENOENT"
+    ) {
+      await fs.mkdir(projectDir, { recursive: true });
+      logger(`Created project directory: ${projectDir}`);
+    } else {
+      throw err;
+    }
+  }
+
+  const dirname = path.dirname(new URL(import.meta.url).pathname);
+
+  logger("Copying files");
+  await fs.copyFile(
+    path.resolve(dirname, "./_eslint.config.js"),
+    path.resolve(projectDir, "eslint.config.js")
+  );
+  await fs.copyFile(
+    path.resolve(dirname, "./_package.json"),
+    path.resolve(projectDir, "package.json")
+  );
+  await fs.copyFile(
+    path.resolve(dirname, "./_tsconfig.json"),
+    path.resolve(projectDir, "tsconfig.json")
+  );
+
+  const manifest = await readPackage({ cwd: projectDir });
+  manifest.name = projectName;
+
+  logger("Writing package.json", manifest);
+  await writePackage(projectDir, manifest);
+}