@jakubmazanec/carson-templates 1.0.0 → 2.0.0-next.2fa8a2c

package/source/constants.ts

@@ -0,0 +1,94 @@
+export const BUILD_DIRECTORY = 'build';
+export const SOURCE_DIRECTORY = 'source';
+
+export const BUILD_TO_ESM_COMMAND = `esbuild "${SOURCE_DIRECTORY}/**/*" --platform=node --target=node20.8 --outdir=${BUILD_DIRECTORY} --sourcemap`;
+export const BUILD_TO_CJS_COMMAND = `esbuild "${SOURCE_DIRECTORY}/**/*" --platform=node --target=node20.8 --format=cjs --outdir=${BUILD_DIRECTORY} --sourcemap`;
+export const FORMAT_COMMAND = 'prettier . --write --ignore-unknown';
+export const TEST_COMMAND = 'vitest run --coverage --passWithNoTests';
+
+export const CARSON_PACKAGE_NAME = '@jakubmazanec/carson';
+export const TEMPLATE_PACKAGE_NAME = '@jakubmazanec/carson-templates';
+
+export const MAIN_BRANCH_NAMES = new Set(['main', 'master']);
+export const DEVELOPMENT_BRANCH_NAMES = new Set(['development', 'develop', 'dev']);
+
+export const LINT_IGNORE_PATTERNS = [
+  '.cache/',
+  '.turbo/',
+  'bin/',
+  'coverage/',
+  'node_modules/',
+  'public/',
+  '*.d.ts',
+  '*.json',
+  '*.md',
+  '*.mdx',
+  `${BUILD_DIRECTORY}/`,
+].sort();
+
+export const FORMAT_IGNORE_PATTERNS = [
+  '.cache/',
+  '.turbo/',
+  'coverage/',
+  'node_modules/',
+  'public/',
+  'npm-shrinkwrap.json',
+  'package-lock.json',
+  'CHANGELOG.md',
+  'LICENSE.md',
+  `${BUILD_DIRECTORY}/`,
+].sort();
+
+export const TSCONFIG_COMPILER_OPTIONS = {
+  allowSyntheticDefaultImports: true,
+  composite: true,
+  exactOptionalPropertyTypes: true,
+  forceConsistentCasingInFileNames: true,
+  isolatedModules: true,
+  jsx: 'react-jsx',
+  lib: ['dom', 'dom.iterable', 'es2022'],
+  module: 'node16',
+  moduleResolution: 'node16',
+  noEmitOnError: false, // TODO: change to `true` when this is fixed: https://github.com/kulshekhar/ts-jest/issues/4198
+  noImplicitOverride: true,
+  noImplicitReturns: true,
+  noUncheckedIndexedAccess: true,
+  skipLibCheck: true,
+  strict: true,
+  target: 'es2022',
+};
+
+export const PRETTIER_OPTIONS = {
+  arrowParens: 'always',
+  bracketSameLine: false,
+  bracketSpacing: false,
+  embeddedLanguageFormatting: 'auto',
+  experimentalTernaries: true,
+  htmlWhitespaceSensitivity: 'css',
+  jsxSingleQuote: false,
+  printWidth: 100,
+  proseWrap: 'always',
+  quoteProps: 'as-needed',
+  requirePragma: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'all',
+  // TODO: remove when this is fixed: https://github.com/prettier/prettier/issues/15956
+  overrides: [
+    {
+      files: ['tsconfig.json'],
+      options: {
+        trailingComma: 'none',
+      },
+    },
+  ],
+};
+
+export const TYPEDOC_CONFIG = {
+  plugin: 'typedoc-plugin-markdown',
+  entryPoints: [`./${SOURCE_DIRECTORY}/main.ts`],
+  out: 'docs',
+  readme: 'none',
+  githubPages: false,
+  hideBreadcrumbs: true,
+};

package/source/dependency-versions.ts

@@ -0,0 +1,69 @@
+import fs from 'node:fs';
+import {createRequire} from 'node:module';
+import semver from 'semver';
+
+import {CARSON_PACKAGE_NAME, TEMPLATE_PACKAGE_NAME} from './constants.js';
+
+let require = createRequire(import.meta.url);
+let carsonPackageVersion =
+  semver
+    .minVersion(
+      (
+        JSON.parse(
+          fs.readFileSync(require.resolve(`${TEMPLATE_PACKAGE_NAME}/package.json`), {
+            encoding: 'utf8',
+          }),
+        ) as {peerDependencies: Record<string, string>}
+      ).peerDependencies[CARSON_PACKAGE_NAME] ?? '^1.0.0',
+    )
+    ?.format() ?? '1.0.0';
+let isCarsonPackageVersionPrerelease = !!semver.prerelease(carsonPackageVersion)?.length;
+let templatesPackageVersion = (
+  JSON.parse(
+    fs.readFileSync(require.resolve(`${TEMPLATE_PACKAGE_NAME}/package.json`), {
+      encoding: 'utf8',
+    }),
+  ) as {version: string}
+).version;
+let isTemplatesPackageVersionPrerelease = !!semver.prerelease(templatesPackageVersion)?.length;
+
+export const DEPENDENCY_VERSIONS: Record<string, string> = {
+  [CARSON_PACKAGE_NAME]:
+    isCarsonPackageVersionPrerelease ? carsonPackageVersion : `^${carsonPackageVersion}`,
+  [TEMPLATE_PACKAGE_NAME]:
+    isTemplatesPackageVersionPrerelease ? templatesPackageVersion : `^${templatesPackageVersion}`,
+
+  '@changesets/cli': '^2.0.0',
+  '@remix-run/dev': '^2.0.0',
+  '@remix-run/express': '^2.0.0',
+  '@remix-run/node': '^2.0.0',
+  '@remix-run/react': '^2.0.0',
+  '@remix-run/serve': '^2.0.0',
+  '@testing-library/jest-dom': '^5.0.0',
+  '@types/lodash': '^4.0.0',
+  '@types/node': '^20.0.0',
+  '@types/react': '^18.0.0',
+  '@types/react-dom': '^18.0.0',
+  '@vitest/coverage-v8': '^1.0.0',
+  autoprefixer: '^10.0.0',
+  concurrently: '^8.0.0',
+  'cross-env': '^7.0.0',
+  'del-cli': '^5.0.0',
+  esbuild: '^0.19.0',
+  eslint: '^8.0.0',
+  lodash: '^4.0.0',
+  isbot: '^4.0.0',
+  'patch-package': '^6.0.0',
+  prettier: '^3.0.0',
+  'prettier-plugin-packagejson': '^2.0.0',
+  'prettier-plugin-tailwindcss': '^0.5.0',
+  react: '^18.0.0',
+  'react-dom': '^18.0.0',
+  tailwindcss: '^3.0.0',
+  turbo: '^1.0.0',
+  typedoc: '^0.24.0',
+  'typedoc-plugin-markdown': '^3.0.0',
+  typescript: '^5.0.0',
+  vite: '^5.0.0',
+  vitest: '^1.0.0',
+};

package/source/getDependencies.ts

@@ -0,0 +1,58 @@
+import {type Workspace} from '@jakubmazanec/carson';
+import semver from 'semver';
+
+import {TEMPLATE_PACKAGE_NAME} from './constants.js';
+import {DEPENDENCY_VERSIONS} from './dependency-versions.js';
+
+function getMajorVersion(version: string) {
+  return Number(version.split('.')[0]!.replace(/\D/, ''));
+}
+
+export function getDependencies(dependencies: string[], workspace: Workspace | Workspace<false>) {
+  const result: Record<string, string> = {};
+
+  for (const dependency of dependencies) {
+    const version = DEPENDENCY_VERSIONS[dependency];
+
+    if (version) {
+      result[dependency] = version;
+    }
+  }
+
+  const projectNames = new Set(workspace.projects.map((project) => project.name));
+
+  for (const [dependencyName, dependencyVersion] of Object.entries(result)) {
+    if (dependencyName === TEMPLATE_PACKAGE_NAME) {
+      continue;
+    }
+
+    const installedDependency = workspace.allDependencies.find(
+      (dependency) => dependencyName === dependency.name,
+    );
+
+    // if the dependency is already installed in the workspace, we might want to use that existing version
+    if (installedDependency) {
+      const version = [...installedDependency.exactVersions].sort().reverse()[0] as string;
+
+      // if the dependency is actually a project in the workspace, we use existing version
+      if (projectNames.has(dependencyName)) {
+        if (semver.prerelease(version)?.length) {
+          result[dependencyName] = version;
+        } else {
+          result[dependencyName] = `^${version}`;
+        }
+      }
+
+      // we use existing version if its major version is equal or greater than major version recommended by the template
+      if (getMajorVersion(version) >= getMajorVersion(dependencyVersion)) {
+        if (semver.prerelease(version)?.length) {
+          result[dependencyName] = version;
+        } else {
+          result[dependencyName] = `^${version}`;
+        }
+      }
+    }
+  }
+
+  return result;
+}

package/source/getDevelopmentBranch.ts

@@ -0,0 +1,13 @@
+import {type Workspace} from '@jakubmazanec/carson';
+
+import {DEVELOPMENT_BRANCH_NAMES} from './constants.js';
+
+export function getDevelopmentBranch(workspace: Workspace | Workspace<false>) {
+  for (let branch of workspace.repository?.branches ?? []) {
+    if (DEVELOPMENT_BRANCH_NAMES.has(branch)) {
+      return branch;
+    }
+  }
+
+  return undefined;
+}

package/source/getMainBranch.ts

@@ -0,0 +1,13 @@
+import {type Workspace} from '@jakubmazanec/carson';
+
+import {MAIN_BRANCH_NAMES} from './constants.js';
+
+export function getMainBranch(workspace: Workspace | Workspace<false>) {
+  for (let branch of workspace.repository?.branches ?? []) {
+    if (MAIN_BRANCH_NAMES.has(branch)) {
+      return branch;
+    }
+  }
+
+  return undefined;
+}

package/source/getReferences.ts

@@ -0,0 +1,29 @@
+import {type Project, type Workspace} from '@jakubmazanec/carson';
+
+export function getReferences(
+  workspace: Workspace | Workspace<false>,
+  project: Project | Project<false>,
+) {
+  let references = [];
+
+  for (let dependency of workspace.allDependencies) {
+    for (let workspaceProject of workspace.projects) {
+      if (dependency.name === workspaceProject.name) {
+        for (let dependencyProject of dependency.projects) {
+          if (dependencyProject.name === project.name) {
+            references.push({
+              path: `${project.relativePath
+                .split('/')
+                .map(() => '..')
+                .join('/')}/${workspaceProject.relativePath}`,
+            });
+          }
+        }
+      }
+    }
+  }
+
+  references.sort((a, b) => a.path.localeCompare(b.path));
+
+  return references;
+}

package/source/getWorkspaceName.ts

@@ -0,0 +1,20 @@
+import {type Workspace} from '@jakubmazanec/carson';
+import path from 'node:path';
+
+const GIT_REPO_REGEXP = /\/([^/]+?)(\.git)?$/;
+
+export function getWorkspaceName(workspace: Workspace | Workspace<false>) {
+  if (workspace.packageJson?.name) {
+    return workspace.packageJson.name;
+  }
+
+  if (workspace.repository?.url) {
+    let matches = workspace.repository.url.match(GIT_REPO_REGEXP);
+
+    if (matches?.[1]) {
+      return matches[1];
+    }
+  }
+
+  return path.basename(workspace.path);
+}

package/source/main.ts

@@ -0,0 +1,8 @@
+export * from './constants.js';
+export * from './getDependencies.js';
+export * from './getDevelopmentBranch.js';
+export * from './getMainBranch.js';
+export * from './getReferences.js';
+export * from './getWorkspaceName.js';
+export {default as lodash} from 'lodash';
+export {default as semver} from 'semver';

package/templates/projects/carson-templates/.eslintrc.cjs.ejs

@@ -0,0 +1,21 @@
+---
+to: '.eslintrc.cjs'
+strategy: overwrite
+---
+/**
+ * DO NOT EDIT!
+ * This file was autogenerated by Carson.
+ * Changes may cause incorrect behavior and will be lost when the file is regenerated.
+ *
+ * Run `npx carson update workspace` to regenerate.
+ */
+
+module.exports = {
+  root: true,
+  extends: [
+    '@jakubmazanec/eslint-config',
+    '@jakubmazanec/eslint-config/nodejs',
+    '@jakubmazanec/eslint-config/prettier',
+  ],
+  ignorePatterns: <%- JSON.stringify(LINT_IGNORE_PATTERNS, null, 2) %>,
+};

package/templates/projects/carson-templates/.prettierignore.ejs

@@ -0,0 +1,3 @@
+---
+extends: '../../workspace/.prettierignore.ejs'
+---

package/templates/projects/carson-templates/CONTRIBUTING.md.ejs

@@ -0,0 +1,3 @@
+---
+extends: '../library/CONTRIBUTING.md.ejs'
+---

package/templates/projects/carson-templates/package.json.ejs

@@ -3,6 +3,22 @@ to: 'package.json'
 strategy: merge
 ---
 <%
+let developmentDependencies = getDependencies(
+  [
+    '@types/node',
+    '@vitest/coverage-v8',
+    'del-cli',
+    'esbuild',
+    'eslint',
+    'prettier',
+    'prettier-plugin-packagejson',
+    'typedoc',
+    'typedoc-plugin-markdown',
+    'typescript',
+    'vitest',
+  ],
+  workspace,
+);
 let packageJson = {
   repository: {
     type: 'git',
@@ -10,25 +26,23 @@ let packageJson = {
   },
   type: 'module',
   exports: {
-    '.': './dist/main.js',
+    '.': `./${BUILD_DIRECTORY}/main.js`,
     './package.json': './package.json',
   },
-  files: ['dist', 'src', 'templates'],
+  files: [BUILD_DIRECTORY, SOURCE_DIRECTORY, 'templates'],
   scripts: {
-    build: 'swc src -d dist && tsc',
-    clean: 'del-cli coverage dist *.tsbuildinfo',
-    document: 'typedoc --options typedoc.config.cjs',
-    format: 'prettier . --write --ignore-unknown --ignore-path ../../.prettierignore',
+    build: `del-cli ${BUILD_DIRECTORY} tsconfig.tsbuildinfo && ${BUILD_TO_ESM_COMMAND} && tsc`,
+    clean: `del-cli coverage ${BUILD_DIRECTORY} *.tsbuildinfo`,
+    document: 'del-cli docs && typedoc --options typedoc.config.cjs',
+      format: FORMAT_COMMAND,
     lint: 'eslint .',
-    test: 'cross-env NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests',
+    test: `del-cli coverage && ${TEST_COMMAND}`,
     typecheck: 'tsc --project tsconfig.typecheck.json',
   },
-  devDependencies: {
-    '@jest/globals': '^29.5.0',
-  },
-  packageManager: 'npm@8.19.4',
+  devDependencies: developmentDependencies,
+  packageManager: 'npm@10.1.0',
   engines: {
-    node: '>=16.20.0',
+    node: '^20.8.0',
   },
 };
 -%>

package/templates/projects/carson-templates/prettier.config.cjs.ejs

@@ -0,0 +1,3 @@
+---
+extends: '../../workspace/prettier.config.cjs.ejs'
+---

package/templates/projects/carson-templates/source/main.ts.check.ejs

@@ -0,0 +1,4 @@
+---
+to: <%- `${SOURCE_DIRECTORY}/main.ts` %>
+strategy: check
+---

package/templates/projects/carson-templates/source/main.ts.create.ejs

@@ -0,0 +1,6 @@
+---
+to: <%- `${SOURCE_DIRECTORY}/main.ts` %>
+strategy: create
+---
+export {}
+

package/templates/projects/carson-templates/tests/tsconfig.json.ejs

@@ -2,16 +2,23 @@
 to: 'tests/tsconfig.json'
 strategy: overwrite
 ---
-{
-  "extends": "../../../tsconfig.options.json",
-  "compilerOptions": {
-    "composite": false,
-    "noEmit": true
+<%
+let tsconfig = {
+  compilerOptions: {
+    ...TSCONFIG_COMPILER_OPTIONS,
+    composite: false,
+    noEmit: true,
   },
-  "include": ["./**/*"],
-  "references": [
-    {
-      "path": ".."
-    }
-  ]
-}
+  include: ['./**/*'],
+  references: [{path: '..'}],
+};
+-%>
+//
+// DO NOT EDIT!
+// This file was autogenerated by Carson.
+// Changes may cause incorrect behavior and will be lost when the file is regenerated.
+//
+// Run `npx carson update workspace` to regenerate.
+//
+
+<%- JSON.stringify(tsconfig, null, 2) %>

package/templates/projects/carson-templates/tsconfig.json.ejs

@@ -2,13 +2,27 @@
 to: 'tsconfig.json'
 strategy: overwrite
 ---
-{
-  "extends": "../../tsconfig.options.json",
-  "compilerOptions": {
-    "emitDeclarationOnly": true,
-    "outDir": "./dist",
-    "rootDir": "./src"
+<%
+let tsconfig = lodash.merge(
+  {
+    compilerOptions: {
+      ...TSCONFIG_COMPILER_OPTIONS,
+      emitDeclarationOnly: true,
+      outDir: `./${BUILD_DIRECTORY}`,
+      rootDir: `./${SOURCE_DIRECTORY}`,
+    },
+    include: [`./${SOURCE_DIRECTORY}/**/*`],
+    references: getReferences(workspace, project),
   },
-  "include": ["./src/**/*"],
-  "references": <%- JSON.stringify(getReferences(workspace, project), null, 2) %>
-}
+  project.config.overrides?.tsconfig ?? {},
+);
+-%>
+//
+// DO NOT EDIT!
+// This file was autogenerated by Carson.
+// Changes may cause incorrect behavior and will be lost when the file is regenerated.
+//
+// Run `npx carson update workspace` to regenerate.
+//
+
+<%- JSON.stringify(tsconfig, null, 2) %>

package/templates/projects/carson-templates/tsconfig.typecheck.json.ejs

@@ -1,14 +1,3 @@
 ---
-to: 'tsconfig.typecheck.json'
-strategy: overwrite
+extends: '../library/tsconfig.typecheck.json.ejs'
 ---
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "composite": false,
-    "emitDeclarationOnly": false,
-    "noEmit": true,
-    "rootDir": "."
-  },
-  "include": ["./src/**/*", "./tests/**/*", "./*"]
-}

package/templates/projects/carson-templates/typedoc.config.cjs.ejs

@@ -1,12 +1,3 @@
 ---
-to: 'typedoc.config.cjs'
-strategy: overwrite
+extends: '../library/typedoc.config.cjs.ejs'
 ---
-module.exports = {
-  plugin: 'typedoc-plugin-markdown',
-  entryPoints: ['./src/main.ts'],
-  out: 'docs',
-  readme: 'none',
-  githubPages: false,
-  hideBreadcrumbs: true,
-};

package/templates/projects/changesets-changelog/.eslintrc.cjs.ejs

@@ -0,0 +1,21 @@
+---
+to: '.eslintrc.cjs'
+strategy: overwrite
+---
+/**
+ * DO NOT EDIT!
+ * This file was autogenerated by Carson.
+ * Changes may cause incorrect behavior and will be lost when the file is regenerated.
+ *
+ * Run `npx carson update workspace` to regenerate.
+ */
+
+module.exports = {
+  root: true,
+  extends: [
+    '@jakubmazanec/eslint-config',
+    '@jakubmazanec/eslint-config/nodejs',
+    '@jakubmazanec/eslint-config/prettier',
+  ],
+  ignorePatterns: <%- JSON.stringify(LINT_IGNORE_PATTERNS, null, 2) %>,
+};

package/templates/projects/changesets-changelog/.prettierignore.ejs

@@ -0,0 +1,3 @@
+---
+extends: '../../workspace/.prettierignore.ejs'
+---

package/templates/projects/changesets-changelog/CONTRIBUTING.md.ejs

@@ -0,0 +1,3 @@
+---
+extends: '../library/CONTRIBUTING.md.ejs'
+---

package/templates/projects/changesets-changelog/package.json.ejs

@@ -3,26 +3,44 @@ to: 'package.json'
 strategy: merge
 ---
 <%
-let packageJson = {
-  repository: {
-    type: 'git',
-    directory: project.relativePath,
+let developmentDependencies = getDependencies(
+  [
+    '@types/node',
+    '@vitest/coverage-v8',
+    'del-cli',
+    'esbuild',
+    'eslint',
+    'prettier',
+    'prettier-plugin-packagejson',
+    'typescript',
+    'vitest',
+  ],
+  workspace,
+);
+let packageJson = lodash.merge(
+  {
+    repository: {
+      type: 'git',
+      directory: project.relativePath,
+    },
+    type: 'commonjs',
+    exports: `./${BUILD_DIRECTORY}/main.js`,
+    files: [BUILD_DIRECTORY, SOURCE_DIRECTORY],
+    scripts: {
+      build: `del-cli ${BUILD_DIRECTORY} tsconfig.tsbuildinfo && ${BUILD_TO_CJS_COMMAND} && tsc`,
+      clean: `del-cli coverage ${BUILD_DIRECTORY} *.tsbuildinfo`,
+      format: FORMAT_COMMAND,
+      lint: 'eslint .',
+      test: `del-cli coverage && ${TEST_COMMAND}`,
+      typecheck: 'tsc --project tsconfig.typecheck.json',
+    },
+    devDependencies: developmentDependencies,
+    packageManager: 'npm@10.1.0',
+    engines: {
+      node: '^20.8.0',
+    },
   },
-  type: 'commonjs',
-  exports: './dist/main.js',
-  files: ['dist', 'src'],
-  scripts: {
-    build: 'swc src -d dist && tsc',
-    clean: 'del-cli coverage dist *.tsbuildinfo',
-    format: 'prettier . --write --ignore-unknown --ignore-path ../../.prettierignore',
-    lint: 'eslint .',
-    test: 'jest --passWithNoTests',
-    typecheck: 'tsc --project tsconfig.typecheck.json',
-  },
-  packageManager: 'npm@8.19.4',
-  engines: {
-    node: '>=16.20.0',
-  },
-};
+  project.config.overrides?.packageJson ?? {},
+);
 -%>
 <%- JSON.stringify(packageJson) %>

package/templates/projects/changesets-changelog/prettier.config.cjs.ejs

@@ -0,0 +1,3 @@
+---
+extends: '../../workspace/prettier.config.cjs.ejs'
+---

package/templates/projects/changesets-changelog/source/main.ts.check.ejs

@@ -0,0 +1,4 @@
+---
+to: <%- `${SOURCE_DIRECTORY}/main.ts` %>
+strategy: check
+---

package/templates/projects/changesets-changelog/source/main.ts.create.ejs

@@ -0,0 +1,6 @@
+---
+to: <%- `${SOURCE_DIRECTORY}/main.ts` %>
+strategy: create
+---
+export {}
+