@gasket/preset-api 7.3.0-canary.5 → 7.3.0

package/README.md

@@ -2,18 +2,10 @@
 
 Framework for building API's using Gasket.
 
-## Usage
-
-This preset requires v5 of the `@gasket/cli`:
-
-```bash
-npm i -g @gasket/cli@^5.0.0
-```
-
 ## Installation
 
 ```bash
-gasket create <app-name> --presets @gasket/preset-api
+npx create-gasket-app <app-name> --presets @gasket/preset-api
 ```
 
 ## Docs
@@ -22,7 +14,6 @@ To see complete the list of plugins configured in your app, and what commands, l
 
 ## Plugins
 
-- [@gasket/plugin-data](/packages/gasket-plugin-data/README.md)
 - [@gasket/plugin-swagger](/packages/gasket-plugin-swagger/README.md)
 - [@gasket/plugin-docs](/packages/gasket-plugin-docs/README.md)
 - [@gasket/plugin-docusaurus](/packages/gasket-plugin-docusaurus/README.md)

package/generator/README.md

@@ -0,0 +1,43 @@
+# {{{appName}}}
+
+{{{appDescription}}}
+
+## Overview
+
+This API is built with {{{server}}}.js framework and [Gasket](https://gasket.dev/). This application utilizes [EcmaScript Modules] and requires Node.js v20 or higher.
+
+## Getting Started
+
+### Development
+
+To start the API locally, run:
+
+```bash
+cd {{{appName}}}
+{{{installCmd}}}
+{{{localCmd}}}
+```
+
+### Debugging
+
+To start the API locally with debugging enabled, run:
+
+```bash
+DEBUG=* {{{localCmd}}}
+```
+
+Extended filtering of the debug output can be achieved by adding to the `DEBUG` environment variable:
+
+```bash
+DEBUG=gasket:* {{{localCmd}}} // gasket operations only
+DEBUG={{{server}}}:* {{{localCmd}}} // {{{server}}} operations only
+```
+
+{{#each readme.markdown}}
+{{{markdownCompile this}}}
+{{/each}}
+<!-- LINKS -->
+[EcmaScript Modules]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+{{#each readme.links}}
+{{{this}}}
+{{/each}}

package/lib/create.js

@@ -4,18 +4,15 @@ import { fileURLToPath } from 'url';
 const require = createRequire(import.meta.url);
 const { devDependencies } = require('../package.json');
 
-/**
- * createHook
- * @param {Gasket} gasket - Gasket API
- * @param {Create} context - Create context
- */
+/** @type {import('@gasket/core').HookHandler<'create'>} */
 export default function create(gasket, context) {
   const { pkg, files } = context;
   const __dirname = fileURLToPath(import.meta.url);
   const generatorDir = path.join(__dirname, '..', '..', 'generator');
+  files.add(`${generatorDir}/*.md`);
 
   if (!context.typescript) {
-    files.add(`${generatorDir}/*`);
+    files.add(`${generatorDir}/*.js`);
 
     pkg.add('devDependencies', {
       nodemon: devDependencies.nodemon
@@ -23,7 +20,8 @@ export default function create(gasket, context) {
 
     pkg.add('scripts', {
       start: 'node server.js',
-      local: 'GASKET_ENV=local nodemon server.js'
+      local: 'nodemon server.js',
+      preview: 'npm run start'
     });
   }
 }

package/lib/index.d.ts

@@ -1,7 +1,5 @@
-import '@gasket/plugin-data';
 import '@gasket/plugin-express';
-// fastify ??
+import '@gasket/plugin-fastify';
 import '@gasket/plugin-https';
 import '@gasket/plugin-lint';
-import '@gasket/plugin-swagger';
 import '@gasket/plugin-winston';

package/lib/index.js

@@ -5,7 +5,7 @@ import create from './create.js';
 const require = createRequire(import.meta.url);
 const { name, version, description } = require('../package.json');
 
-// TODO: need to create types for "preset" plugins
+/** @type {import('@gasket/core').Preset} */
 export default {
   name,
   version,

package/lib/preset-config.js

@@ -1,7 +1,14 @@
+// Default Plugins - included by default for all presets
+import pluginCommand from '@gasket/plugin-command';
+import pluginDocs from '@gasket/plugin-docs';
+import pluginDocusaurus from '@gasket/plugin-docusaurus';
+import pluginDynamicPlugins from '@gasket/plugin-dynamic-plugins';
+import pluginGit from '@gasket/plugin-git';
+import pluginLogger from '@gasket/plugin-logger';
+
+// Preset-specific Plugins
 import pluginHttps from '@gasket/plugin-https';
-import pluginData from '@gasket/plugin-data';
 import pluginWinston from '@gasket/plugin-winston';
-import pluginSwagger from '@gasket/plugin-swagger';
 import pluginLint from '@gasket/plugin-lint';
 
 /**
@@ -11,34 +18,42 @@ import pluginLint from '@gasket/plugin-lint';
  * @returns {Promise<CreateContext.presetConfig>} config
  */
 export default async function presetConfig(gasket, context) {
-  let typescriptPlugin;
-  const testPlugins = [];
-  // TODO: test canary publish without fastify dependency
+  const plugins = new Set([
+    pluginCommand,
+    pluginDocs,
+    pluginDocusaurus,
+    pluginDynamicPlugins,
+    pluginGit,
+    pluginHttps,
+    pluginLint,
+    pluginLogger,
+    pluginWinston
+  ]);
+
   const frameworkPlugin = context.server === 'express'
     ? await import('@gasket/plugin-express')
     : await import('@gasket/plugin-fastify');
 
+  plugins.add(frameworkPlugin.default || frameworkPlugin);
+
   if ('testPlugins' in context && context.testPlugins.length > 0) {
     await Promise.all(context.testPlugins.map(async (testPlugin) => {
       const plugin = await import(testPlugin);
-      testPlugins.push(plugin ? plugin.default || plugin : null);
+      plugins.add(plugin ? plugin.default || plugin : null);
     }));
   }
 
   if (context.typescript) {
-    typescriptPlugin = await import('@gasket/plugin-typescript');
+    const typescriptPlugin = await import('@gasket/plugin-typescript');
+    plugins.add(typescriptPlugin.default || typescriptPlugin);
+  }
+
+  if (context.useSwagger) {
+    const swaggerPlugin = await import('@gasket/plugin-swagger');
+    plugins.add(swaggerPlugin.default || swaggerPlugin);
   }
 
   return {
-    plugins: [
-      pluginHttps,
-      pluginData,
-      pluginWinston,
-      pluginSwagger,
-      pluginLint,
-      frameworkPlugin.default || frameworkPlugin,
-      typescriptPlugin ? typescriptPlugin.default || typescriptPlugin : null,
-      ...testPlugins
-    ].filter(Boolean)
+    plugins: Array.from(plugins)
   };
 }

package/lib/preset-prompt.js

@@ -1,4 +1,5 @@
 import typescriptPrompts from '@gasket/plugin-typescript/prompts';
+import swaggerPrompts from '@gasket/plugin-swagger/prompts';
 
 /**
  * presetPrompt hook
@@ -11,6 +12,7 @@ export default async function presetPrompt(gasket, context, { prompt }) {
   context.apiApp = true;
 
   await typescriptPrompts.promptTypescript(context, prompt);
+  await swaggerPrompts.promptSwagger(context, prompt);
 
   if (!('server' in context)) {
     const { server } = await prompt([
@@ -26,5 +28,7 @@ export default async function presetPrompt(gasket, context, { prompt }) {
     ]);
 
     Object.assign(context, { server });
+
+    return context;
   }
 }

package/package.json

@@ -1,22 +1,14 @@
 {
   "name": "@gasket/preset-api",
-  "version": "7.3.0-canary.5",
+  "version": "7.3.0",
   "description": "Create Express-based API with Gasket",
+  "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
     "generator",
     "lib"
   ],
-  "type": "module",
-  "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "npm run lint -- --fix",
-    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
-    "test:watch": "npm run test -- --watch",
-    "test:coverage": "jest --coverage",
-    "posttest": "npm run lint"
-  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/godaddy/gasket.git"
@@ -29,26 +21,39 @@
   "bugs": {
     "url": "https://github.com/godaddy/gasket/issues"
   },
+  "homepage": "https://github.com/godaddy/gasket/tree/main/packages/gasket-preset-api",
   "dependencies": {
-    "@gasket/plugin-cypress": "^7.3.0-canary.5",
-    "@gasket/plugin-data": "^7.0.0-next.41",
-    "@gasket/plugin-express": "^7.0.0-next.41",
-    "@gasket/plugin-https": "^7.0.0-next.41",
-    "@gasket/plugin-jest": "^7.3.0-canary.5",
-    "@gasket/plugin-lint": "^7.0.0-next.41",
-    "@gasket/plugin-mocha": "^7.3.0-canary.5",
-    "@gasket/plugin-swagger": "^7.0.0-next.41",
-    "@gasket/plugin-typescript": "^7.3.0-canary.5",
-    "@gasket/plugin-winston": "^7.0.0-next.41"
+    "@gasket/plugin-command": "^7.3.0",
+    "@gasket/plugin-cypress": "^7.3.0",
+    "@gasket/plugin-docs": "^7.3.0",
+    "@gasket/plugin-docusaurus": "^7.3.0",
+    "@gasket/plugin-dynamic-plugins": "^7.3.0",
+    "@gasket/plugin-express": "^7.3.0",
+    "@gasket/plugin-fastify": "^7.3.0",
+    "@gasket/plugin-https": "^7.3.0",
+    "@gasket/plugin-jest": "^7.3.0",
+    "@gasket/plugin-lint": "^7.3.0",
+    "@gasket/plugin-logger": "^7.3.0",
+    "@gasket/plugin-mocha": "^7.3.0",
+    "@gasket/plugin-swagger": "^7.3.0",
+    "@gasket/plugin-typescript": "^7.3.0",
+    "@gasket/plugin-winston": "^7.3.0",
+    "@gasket/plugin-git": "^7.3.0"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.17.19",
     "cross-env": "^7.0.3",
-    "eslint": "^8.56.0",
-    "eslint-config-godaddy": "^7.0.2",
-    "eslint-plugin-jest": "^27.6.3",
-    "eslint-plugin-unicorn": "^44.0.0",
+    "eslint": "^8.57.1",
+    "eslint-config-godaddy": "^7.1.1",
+    "eslint-config-godaddy-typescript": "^4.0.3",
+    "eslint-plugin-jest": "^28.11.0",
+    "eslint-plugin-unicorn": "^55.0.0",
     "jest": "^29.7.0",
-    "nodemon": "^3.1.0"
+    "nodemon": "^3.1.9",
+    "typescript": "^5.7.3",
+    "@gasket/plugin-metadata": "^7.3.0",
+    "create-gasket-app": "^7.3.0"
   },
   "eslintConfig": {
     "extends": [
@@ -63,10 +68,18 @@
     }
   },
   "eslintIgnore": [
-    "test/fixtures"
+    "test/fixtures",
+    "generator"
   ],
   "jest": {
     "transform": {}
   },
-  "gitHead": "8b38b2d0b56d8dfca7e755202c00a064e9de51d0"
-}
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "pnpm run lint --fix",
+    "test": "cross-env NODE_OPTIONS='--unhandled-rejections=strict --experimental-vm-modules' jest",
+    "test:watch": "pnpm run test --watch",
+    "test:coverage": "jest --coverage",
+    "posttest": "pnpm run lint"
+  }
+}