@jakubmazanec/carson-templates 2.3.0-unstable.f5bd618 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jakubmazanec/carson-templates",
-  "version": "2.3.0-unstable.f5bd618",
+  "version": "2.3.0",
   "description": "Collection of Carson templates.",
   "repository": {
     "type": "git",
@@ -31,7 +31,7 @@
   },
   "dependencies": {
     "lodash": "^4.17.21",
-    "semver": "^7.6.0"
+    "semver": "^7.6.2"
   },
   "devDependencies": {
     "@jakubmazanec/carson": "^1.1.0",
@@ -43,17 +43,17 @@
     "@types/zen-observable": "^0.8.7",
     "@vitest/coverage-v8": "^1.3.1",
     "del-cli": "^5.1.0",
-    "esbuild": "^0.20.1",
+    "esbuild": "^0.21.4",
     "eslint": "^8.56.0",
-    "execa": "^8.0.1",
+    "execa": "^9.1.0",
     "fast-glob": "^3.3.2",
     "fs-extra": "^11.2.0",
     "lodash": "^4.17.21",
-    "prettier": "^3.2.5",
-    "prettier-plugin-packagejson": "^2.4.12",
-    "typedoc": "^0.25.10",
-    "typedoc-plugin-markdown": "^3.17.1",
-    "typescript": "^5.3.3",
+    "prettier": "^3.3.0",
+    "prettier-plugin-packagejson": "^2.5.0",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.3",
+    "typescript": "^5.4.5",
     "vitest": "^1.3.1",
     "zen-observable": "^0.10.0"
   },

package/templates/projects/remix-app/.eslintrc.cjs.ejs

@@ -3,11 +3,11 @@ to: '.eslintrc.cjs'
 strategy: overwrite
 ---
 <%
-let lintIgnorePatterns = [
-  ...LINT_IGNORE_PATTERNS,
-  'dbschema/edgeql-js/',
-  'dbschema/interfaces.*',
-];
+let lintIgnorePatterns = [...LINT_IGNORE_PATTERNS];
+
+if (project.config.deployment?.dbInstance) {
+  lintIgnorePatterns.push('dbschema/edgeql-js/', 'dbschema/interfaces.*');
+}
 -%>
 /**
  * DO NOT EDIT!

package/templates/projects/remix-app/Dockerfile.ejs

@@ -11,12 +11,13 @@ for (let project of workspace.projects) {
 }
 
 let copyFilesLines = ['COPY package-lock.json package.json /workspace/'];
+let currentProject = project;
 
 for (let project of workspace.projects) {
-  if (project.config.deployment?.appName) {
+  if (project.config.deployment?.appName && project.name === currentProject.name) {
     copyFilesLines.push(`COPY --from=build /workspace/${project.relativePath}/build /workspace/${project.relativePath}/build`);
     copyFilesLines.push(`COPY --from=build /workspace/${project.relativePath}/package.json /workspace/${project.relativePath}/package.json`);
-  } else {
+  } else if (!project.config.deployment?.appName) {
     if (project.packageJson.bin) {
       copyFilesLines.push(`COPY --from=build /workspace/${project.relativePath}/bin /workspace/${project.relativePath}/bin`);
     }
@@ -39,14 +40,24 @@ FROM node:20-slim as base
 
 WORKDIR /workspace
 
+# Set up env variables
 ENV NODE_ENV=production
+<%
+if (project.config.deployment?.dbInstance) {
+-%>
+ARG EDGEDB_INSTANCE
+ENV EDGEDB_INSTANCE=$EDGEDB_INSTANCE
+ARG EDGEDB_BRANCH
+ENV EDGEDB_BRANCH=$EDGEDB_BRANCH
+<%
+}
+-%>
 
 # Throw-away build stage to reduce size of final image
 FROM base as build
 
 # Install packages needed to install dependencies
-RUN apt-get update -qq && \
-    apt-get install --no-install-recommends -y build-essential node-gyp pkg-config python-is-python3
+RUN apt-get update -qq && apt-get install --no-install-recommends -y build-essential node-gyp pkg-config python-is-python3
 
 # Install dependencies
 <%- installDependenciesLines.join('\n') %>
@@ -59,7 +70,7 @@ COPY --link . .
 <%
 if (project.config.deployment?.dbInstance) {
 -%>
-RUN --mount=type=secret,id=EDGEDB_INSTANCE --mount=type=secret,id=EDGEDB_SECRET_KEY EDGEDB_INSTANCE="$(cat /run/secrets/EDGEDB_INSTANCE)" EDGEDB_SECRET_KEY="$(cat /run/secrets/EDGEDB_SECRET_KEY)" npm run build
+RUN --mount=type=secret,id=EDGEDB_SECRET_KEY EDGEDB_SECRET_KEY="$(cat /run/secrets/EDGEDB_SECRET_KEY)" npm run build
 <%
 } else {
 -%>
@@ -78,6 +89,6 @@ FROM base
 RUN npm ci --omit=dev --ignore-scripts
 
 # Start the server
-WORKDIR /workspace/apps/somewhere
+WORKDIR /workspace/<%- project.relativePath %>
 EXPOSE 5000
 ENTRYPOINT ["npm", "start"]

package/templates/projects/remix-app/README.md.create.ejs

@@ -22,5 +22,5 @@ If you want to contribute, see [CONTRIBUTING](./CONTRIBUTING.md) for details.
 
 ## License
 
-This package is licensed under the GNU Affero General Public License v3. See [LICENSE](./LICENSE.md)
+This app is licensed under the GNU Affero General Public License v3. See [LICENSE](./LICENSE.md)
 for details.

package/templates/projects/remix-app/tsconfig.json.ejs

@@ -12,13 +12,17 @@ let tsconfig = lodash.merge(
       noEmit: true,
       resolveJsonModule: true,
       rootDir: '.',
-      exactOptionalPropertyTypes: project.config.deployment?.dbInstance ? false : true, // TODO: when EdgeDB client supports `exactOptionalPropertyTypes: true`, remove this line
     },
     include: project.config.deployment?.dbInstance ? ['./app/**/*', './dbschema/**/*', './*'] : ['./app/**/*', './*'],
     references: getReferences(workspace, project),
   },
   project.config.overrides?.tsconfig ?? {},
 );
+
+// TODO: when EdgeDB client supports `exactOptionalPropertyTypes: true`, remove this line
+if (project.config.deployment?.dbInstance) {
+  tsconfig.compilerOptions.exactOptionalPropertyTypes = false;
+}
 -%>
 //
 // DO NOT EDIT!

package/templates/projects/remix-app/tsconfig.typecheck.json.ejs

@@ -10,7 +10,6 @@ let tsconfig = lodash.merge(
       composite: false,
     },
     include: project.config.deployment?.dbInstance ? ['./app/**/*', './dbschema/**/*', './tests/**/*', './*'] : ['./app/**/*', './tests/**/*', './*'],
-    references: getReferences(workspace, project),
   },
   project.config.overrides?.tsconfig ?? {},
 );

package/templates/workspace/.github/workflows/check-pull-request.yaml.ejs

@@ -88,7 +88,7 @@ if (workspace.projects.some((project) => project.config.deployment?.dbInstance))
 
           git config --unset core.filemode
 
-      - name: Run tests
+      - name: Test
         run: npm test <%- appsWithDbFilter %>
 
 <%
@@ -96,13 +96,13 @@ for (let project of workspace.projects) {
   if (project.config.deployment?.dbInstance) {
 -%>
 
-      - name: Run tests
+      - name: Test "<%- project.name %>"
         run: |
           npm run test -- --filter=<%- project.name %>
         env:
           EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
           EDGEDB_BRANCH: ${{ github.head_ref }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
+          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance).toUpperCase() %>_EDGEDB_TOKEN }}
 <%
   }
 }

package/templates/workspace/.github/workflows/release-pull-request.yaml.ejs

@@ -3,14 +3,25 @@ to: '.github/workflows/release-pull-request.yaml'
 strategy: overwrite
 ---
 <%
+let apps = [];
 let appsWithDb = [];
 
 for (let project of workspace.projects) {
+  if (project.config.deployment?.appName) {
+    apps.push(project.name);
+  }
+
   if (project.config.deployment?.dbInstance) {
     appsWithDb.push(project.name);
   }
 }
 
+let appsFilter = apps.map((name) => `--filter=!${name}`).join(' ');
+
+if (appsFilter) {
+  appsFilter = `-- ${appsFilter}`;
+}
+
 let appsWithDbFilter = appsWithDb.map((name) => `--filter=!${name}`).join(' ');
 
 if (appsWithDbFilter) {
@@ -96,7 +107,7 @@ if (workspace.projects.some((project) => project.config.deployment?.dbInstance))
 
           git config --unset core.filemode
 
-      - name: Run tests
+      - name: Test
         run: npm test <%- appsWithDbFilter %>
 
 <%
@@ -104,13 +115,13 @@ for (let project of workspace.projects) {
   if (project.config.deployment?.dbInstance) {
 -%>
 
-      - name: Run tests
+      - name: Test "<%- project.name %>"
         run: |
           npm run test -- --filter=<%- project.name %>
         env:
           EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
           EDGEDB_BRANCH: ${{ github.head_ref }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
+          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance).toUpperCase() %>_EDGEDB_TOKEN }}
 <%
   }
 }
@@ -131,24 +142,7 @@ for (let project of workspace.projects) {
           git config --unset core.filemode
 
       - name: Build packages
-        run: npm run build <%- appsWithDbFilter %>
-
-<%
-for (let project of workspace.projects) {
-  if (project.config.deployment?.dbInstance) {
--%>
-
-      - name: Build <%- project.name %>
-        run: |
-          npm run build -- --filter=<%- project.name %>
-        env:
-          EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
-          EDGEDB_BRANCH: ${{ github.head_ref }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
-<%
-  }
-}
--%>
+        run: npm run build <%- appsFilter %>
 
       - name: Authenticate to npm registry
         run: |
@@ -177,13 +171,13 @@ for (let project of workspace.projects) {
 
       - name: Deploy <%- project.name %>
         run: |
-          npm run deploy --workspace <%- project.name %> -- --app <%- project.config.deployment?.appName %>-unstable --build-secret "EDGEDB_INSTANCE=$EDGEDB_INSTANCE" --build-secret "EDGEDB_SECRET_KEY=$EDGEDB_SECRET_KEY"
+          npm run deploy --workspace <%- project.name %> -- --app <%- project.config.deployment?.appName %>-unstable --build-arg "EDGEDB_INSTANCE=$EDGEDB_INSTANCE" --build-arg "EDGEDB_BRANCH=$EDGEDB_BRANCH" --build-secret "EDGEDB_SECRET_KEY=$EDGEDB_SECRET_KEY"
         env:
           FLY_ACCESS_TOKEN: ${{ secrets.FLY_TOKEN }}
           FLY_API_TOKEN: ${{ secrets.FLY_TOKEN }}
           EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
           EDGEDB_BRANCH: ${{ github.head_ref }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
+          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance).toUpperCase() %>_EDGEDB_TOKEN }}
 <%
   } else if (project.config.deployment?.appName) {
 -%>

package/templates/workspace/.github/workflows/release.yaml.ejs

@@ -3,14 +3,25 @@ to: '.github/workflows/release.yaml'
 strategy: overwrite
 ---
 <%
+let apps = [];
 let appsWithDb = [];
 
 for (let project of workspace.projects) {
+  if (project.config.deployment?.appName) {
+    apps.push(project.name);
+  }
+
   if (project.config.deployment?.dbInstance) {
     appsWithDb.push(project.name);
   }
 }
 
+let appsFilter = apps.map((name) => `--filter=!${name}`).join(' ');
+
+if (appsFilter) {
+  appsFilter = `-- ${appsFilter}`;
+}
+
 let appsWithDbFilter = appsWithDb.map((name) => `--filter=!${name}`).join(' ');
 
 if (appsWithDbFilter) {
@@ -100,17 +111,17 @@ for (let project of workspace.projects) {
 
       - name: Migrate "<%- project.name %>"
         run: |
-          edgedb migrate
+          edgedb migrate --schema-dir <%- project.relativePath %>/dbschema
         env:
           EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
           EDGEDB_BRANCH: ${{ github.ref_name  }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
+          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance).toUpperCase() %>_EDGEDB_TOKEN }}
 <%
   }
 }
 -%>
 
-      - name: Run tests
+      - name: Test
         run: npm test <%- appsWithDbFilter %>
 
 <%
@@ -118,13 +129,13 @@ for (let project of workspace.projects) {
   if (project.config.deployment?.dbInstance) {
 -%>
 
-      - name: Run tests
+      - name: Test "<%- project.name %>"
         run: |
           npm run test -- --filter=<%- project.name %>
         env:
           EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
-          EDGEDB_BRANCH: ${{ github.head_ref }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
+          EDGEDB_BRANCH: ${{ github.ref_name }}
+          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance).toUpperCase() %>_EDGEDB_TOKEN }}
 <%
   }
 }
@@ -145,7 +156,7 @@ for (let project of workspace.projects) {
           git config --unset core.filemode
 
       - name: Build packages
-        run: npm run build <%- appsWithDbFilter %>
+        run: npm run build <%- appsFilter %>
 
       - name: Authenticate to npm registry
         run: |
@@ -203,13 +214,13 @@ for (let project of workspace.projects) {
 
       - name: Deploy "<%- project.name %>"
         run: |
-          npm run deploy --workspace <%- project.name %> -- --build-secret "EDGEDB_INSTANCE=$EDGEDB_INSTANCE" --build-secret "EDGEDB_SECRET_KEY=$EDGEDB_SECRET_KEY"
+          npm run deploy --workspace <%- project.name %> -- --build-arg "EDGEDB_INSTANCE=$EDGEDB_INSTANCE" --build-arg "EDGEDB_BRANCH=$EDGEDB_BRANCH" --build-secret "EDGEDB_SECRET_KEY=$EDGEDB_SECRET_KEY"
         env:
           FLY_ACCESS_TOKEN: ${{ secrets.FLY_TOKEN }}
           FLY_API_TOKEN: ${{ secrets.FLY_TOKEN }}
           EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
-          EDGEDB_BRANCH: ${{ github.head_ref }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
+          EDGEDB_BRANCH: ${{ github.ref_name }}
+          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance).toUpperCase() %>_EDGEDB_TOKEN }}
 <%
   } else if (project.config.deployment?.appName) {
 -%>
@@ -309,18 +320,18 @@ for (let project of workspace.projects) {
 -%>
 
       - name: Migrate "<%- project.name %>"
+        run: |
+          edgedb migrate --schema-dir <%- project.relativePath %>/dbschema
         env:
           EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
           EDGEDB_BRANCH: ${{ github.ref_name  }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
-        run: |
-          edgedb migrate
+          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance).toUpperCase() %>_EDGEDB_TOKEN }}
 <%
   }
 }
 -%>
 
-      - name: Run tests
+      - name: Test
         run: npm test <%- appsWithDbFilter %>
 
 <%
@@ -328,13 +339,13 @@ for (let project of workspace.projects) {
   if (project.config.deployment?.dbInstance) {
 -%>
 
-      - name: Run tests
+      - name: Test "<%- project.name %>"
         run: |
           npm run test -- --filter=<%- project.name %>
         env:
           EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
-          EDGEDB_BRANCH: ${{ github.head_ref }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
+          EDGEDB_BRANCH: ${{ github.ref_name }}
+          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance).toUpperCase() %>_EDGEDB_TOKEN }}
 <%
   }
 }
@@ -355,7 +366,7 @@ for (let project of workspace.projects) {
           git config --unset core.filemode
 
       - name: Build packages
-        run: npm run build <%- appsWithDbFilter %>
+        run: npm run build <%- appsFilter %>
 
       - name: Update documentation
         run: |
@@ -394,13 +405,13 @@ for (let project of workspace.projects) {
 
       - name: Deploy "<%- project.name %>"
         run: |
-          npm run deploy --workspace <%- project.name %> -- --app <%- project.config.deployment?.appName %>-next --build-secret "EDGEDB_INSTANCE=$EDGEDB_INSTANCE" --build-secret "EDGEDB_SECRET_KEY=$EDGEDB_SECRET_KEY"
+          npm run deploy --workspace <%- project.name %> -- --app <%- project.config.deployment?.appName %>-next --build-arg "EDGEDB_INSTANCE=$EDGEDB_INSTANCE" --build-arg "EDGEDB_BRANCH=$EDGEDB_BRANCH" --build-secret "EDGEDB_SECRET_KEY=$EDGEDB_SECRET_KEY"
         env:
           FLY_ACCESS_TOKEN: ${{ secrets.FLY_TOKEN }}
           FLY_API_TOKEN: ${{ secrets.FLY_TOKEN }}
           EDGEDB_INSTANCE: <%- project.config.deployment.dbInstance %>
-          EDGEDB_BRANCH: ${{ github.head_ref }}
-          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance.split('/')[1] ?? '').toUpperCase() %>_EDGEDB_TOKEN }}
+          EDGEDB_BRANCH: ${{ github.ref_name }}
+          EDGEDB_SECRET_KEY: ${{ secrets.<%- lodash.snakeCase(project.config.deployment.dbInstance).toUpperCase() %>_EDGEDB_TOKEN }}
 <%
   } else if (project.config.deployment?.appName) {
 -%>