@digigov/cli-app 1.2.3 → 2.0.0-07ee8440

package/{next.common.js → next.common.cjs}

@@ -1,8 +1,8 @@
-const path = require('path');
-const lib = require('@digigov/cli/lib');
-let aliases = lib.aliases(null, true);
-const withImages = require('next-images');
-const { makeBabelConfig } = require('@digigov/cli-build/babel.common');
+const path = require("path");
+const lib = require("@digigov/cli/lib");
+let aliases = lib.aliases(true);
+const withImages = require("next-images");
+const { makeBabelConfig } = require("@digigov/cli-build/babel.common.cjs");
 
 function makeNextConfig(dir) {
   const project = lib.resolveProject(dir);
@@ -13,7 +13,7 @@ function makeNextConfig(dir) {
       ...digigov.aliases,
     };
   }
-  console.log(`Creating aliases for ${Object.keys(aliases).join(', ')}`);
+  console.log(`Creating aliases for ${Object.keys(aliases).join(", ")}`);
   const nextConfig = withImages({
     poweredByHeader: false,
     trailingSlash: true,

package/next.config.cjs

@@ -0,0 +1 @@
+module.exports = require("./next.common.cjs").config;

package/nextrc.cjs

@@ -0,0 +1,5 @@
+const { makeConfig } = require("@digigov/cli/lib");
+
+module.exports = (overrides) => {
+  return makeConfig(overrides, require("./next.common.cjs").config);
+};

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@digigov/cli-app",
-  "version": "1.2.3",
+  "version": "2.0.0-07ee8440",
   "description": "@digigov developer cli tool",
-  "main": "index.js",
+  "main": "./index.js",
+  "type": "module",
   "author": "GRNET Developers <devs@lists.grnet.gr>",
   "license": "BSD-2-Clause",
   "dependencies": {
@@ -10,27 +11,40 @@
     "express": "4.17.1",
     "http-proxy-middleware": "1.0.3",
     "next-images": "1.3.0",
-    "@digigov/cli-build": "1.1.1",
+    "@digigov/cli-build": "2.0.0-07ee8440",
     "url-loader": "4.1.1",
     "next": "13.1.1",
-    "publint": "0.1.8",
-    "yargs": "17.7.2",
-    "@oclif/command": "1.8.0",
-    "glob": "7.1.6"
+    "commander": "12.1.0",
+    "globby": "11.0.0",
+    "publint": "0.1.8"
   },
   "peerDependencies": {
     "rimraf": "3.0.2",
-    "execa": "5.0.0",
-    "@digigov/cli": "1.1.0",
-    "typescript": "5.3.2",
+    "@digigov/cli": "2.0.0-07ee8440",
+    "typescript": "5.6.2",
     "@types/node": "18.19.0",
     "@types/react": "18.3.3",
     "autoprefixer": "10.4.16",
     "postcss": "8.4.4",
-    "@digigov/css": "1.2.0",
-    "tailwindcss": "3.3.5"
+    "@digigov/css": "2.0.0-07ee8440",
+    "tailwindcss": "3.4.13"
+  },
+  "exports": {
+    ".": "./index.js",
+    "./next.common": "./next.common.cjs",
+    "./next.config": "./next.config.cjs",
+    "./nextrc": "./nextrc.cjs",
+    "./postcss.config": "./postcss.config.cjs",
+    "./postcss.common": "./postcss.common.cjs",
+    "./postcssrc": "./postcssrc.cjs",
+    "./tailwind.config": "./tailwind.config.cjs",
+    "./tailwind.common": "./tailwind.common.cjs",
+    "./tailwindrc": "./tailwindrc.cjs"
+  },
+  "devDependencies": {
+    "typescript": "5.6.2"
   },
   "scripts": {
     "publint": "publint"
   }
-}
+}

package/postcss.config.cjs

@@ -0,0 +1 @@
+module.exports = require("./postcss.common.cjs").config;

package/postcssrc.cjs

@@ -0,0 +1,5 @@
+const { makeConfig } = require("@digigov/cli/lib");
+
+module.exports = (overrides) => {
+  return makeConfig(overrides, require("./postcss.common.cjs"));
+};

package/subcommands/build.js

@@ -0,0 +1,15 @@
+import { DigigovCommand } from "@digigov/cli/lib";
+import { EXEC_CONFIG } from "../common.js";
+
+const buildCommand = new DigigovCommand("build");
+
+buildCommand
+  .argument("[...args]", "Arguments to pass to the `next build` command")
+  .helpOption(false)
+  .allowUnknownOption()
+  .action(async (args = [], _, ctx) => {
+    await ctx.exec("rimraf", ["out"]);
+    await ctx.exec("next", ["build", ...args], EXEC_CONFIG);
+  });
+
+export default buildCommand;

package/subcommands/dev.js

@@ -0,0 +1,28 @@
+import { DigigovCommand, resolveProject, logger } from "@digigov/cli/lib";
+import { EXEC_CONFIG } from "../common.js";
+
+import path from "path";
+import { fileURLToPath } from "url";
+
+const { digigov } = resolveProject();
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const devCommand = new DigigovCommand("dev");
+
+devCommand
+  .argument("[...args]", "Arguments to pass to the `next dev` command")
+  .helpOption(false)
+  .allowUnknownOption()
+  .action(async (args = [], _, ctx) => {
+    logger.info("Starting development server...");
+    if (digigov && digigov.proxy) {
+      await ctx.exec(
+        "node",
+        [path.resolve(__dirname, "../utils/proxy-server.js")],
+        EXEC_CONFIG,
+      );
+    }
+    await ctx.exec("next", ["dev", ...(args ?? [])], EXEC_CONFIG);
+  });
+
+export default devCommand;

package/subcommands/export.js

@@ -0,0 +1,16 @@
+import { DigigovCommand } from "@digigov/cli/lib";
+import { EXEC_CONFIG } from "../common.js";
+
+const exportCommand = new DigigovCommand("export");
+
+exportCommand
+  .argument("[...args]", "Arguments to pass to the `next export` command")
+  .helpOption(false)
+  .allowUnknownOption()
+  .action(async (args = [], _, ctx) => {
+    await ctx.exec("rimraf", ["out"]);
+    await ctx.exec("next", ["build"]);
+    await ctx.exec("next", ["export", ...args], EXEC_CONFIG);
+  });
+
+export default exportCommand;

package/subcommands/start.js

@@ -0,0 +1,22 @@
+import fs from "fs";
+
+import { DigigovCommand, resolveProject } from "@digigov/cli/lib";
+import { EXEC_CONFIG } from "../common.js";
+import path from "path";
+
+const startCommand = new DigigovCommand("start");
+
+const project = resolveProject();
+
+startCommand
+  .argument("[...args]", "Arguments to pass to the `next start` command")
+  .helpOption(false)
+  .allowUnknownOption()
+  .action(async (args = [], _, ctx) => {
+    if (!fs.existsSync(path.join(project.root, ".next"))) {
+      await ctx.exec("next", ["build"]);
+    }
+    await ctx.exec("next", ["start", ...args], EXEC_CONFIG);
+  });
+
+export default startCommand;

package/subcommands/test.js

@@ -0,0 +1,34 @@
+import { Option } from "commander";
+
+import { logger, DigigovCommand } from "@digigov/cli/lib";
+import generatePagesTestFile from "../utils/test-init.js";
+
+const testCommand = new DigigovCommand("test");
+
+testCommand
+  .description("Initialize project with specified parameters")
+  .option(
+    "-b, --base-url",
+    "The base url of the running project",
+    "http://localhost:3000",
+  )
+  .option(
+    "-p, --pages-path",
+    "The directory where the pages are located relative to the project folder",
+    "pages",
+  )
+  .addOption(
+    new Option("-s, --screen-sizes", "The screen sizes for viewport")
+      .choices(["xs", "lg"])
+      .default("lg"),
+  )
+  .action(async (options) => {
+    const { baseUrl, pagesPath, screenSizes } = options;
+    logger.log(
+      `Generating test files for pagesPath "${pagesPath}" with baseUrl "${baseUrl}" for screen sizes "${screenSizes}"`,
+    );
+    const projectFolder = process.cwd();
+    generatePagesTestFile(projectFolder, pagesPath, baseUrl, screenSizes);
+  });
+
+export default testCommand;

package/tailwind.config.cjs

@@ -0,0 +1 @@
+module.exports = require("./tailwind.common.cjs").config;

package/tailwindrc.cjs

@@ -0,0 +1,5 @@
+const { makeConfig } = require("@digigov/cli/lib");
+
+module.exports = (overrides) => {
+  return makeConfig(overrides, require("./tailwind.common.cjs"));
+};

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@digigov/cli/tsconfig.cli",
+  "include": ["./*.js", "./subcommands", "./utils"]
+}

package/utils/proxy-server.js

@@ -0,0 +1,47 @@
+import express from "express";
+import next from "next";
+import path from "path";
+import { createRequire } from "module";
+
+import { resolveProject } from "@digigov/cli/lib";
+
+const port = parseInt(process.env["PORT"] ?? "3000", 10);
+const isDev = process.env.NODE_ENV !== "production";
+
+const project = resolveProject();
+const devProxy = project.digigov.proxy;
+
+const require = createRequire(import.meta.url);
+const conf = require(path.join(project.root, "next.config.js"));
+
+const app = next.default({
+  dir: project.root, // base directory where everything is, could move to src later
+  dev: isDev,
+  conf,
+});
+const handle = app.getRequestHandler();
+
+app
+  .prepare()
+  .then(() => {
+    const server = express();
+
+    // Set up the proxy.
+    if (isDev && devProxy) {
+      const { createProxyMiddleware } = require("http-proxy-middleware");
+      Object.keys(devProxy).forEach(function (context) {
+        server.use(createProxyMiddleware(context, devProxy[context]));
+      });
+    }
+
+    // Default catch-all handler to allow Next.js to handle all other routes
+    server.all("*", (req, res) => handle(req, res));
+
+    server.listen(port, () => {
+      console.log(`> Ready on port ${port}`);
+    });
+  })
+  .catch((err) => {
+    console.log("An error occurred, unable to start the server");
+    console.log(err);
+  });

package/utils/test-init.js

@@ -0,0 +1,177 @@
+import fs from "fs";
+import path from "path";
+import glob from "globby";
+
+const FILE_EXTENSIONS = ["js", "jsx", "ts", "tsx"];
+
+/**
+ * @typedef {"xs" | "lg"} ScreenSize
+ */
+
+const SCREEN_SIZES = {
+  xs: { width: 375, height: 667, deviceScaleFactor: 1 },
+  lg: { width: 1280, height: 720, deviceScaleFactor: 2 },
+};
+
+/**
+ * Append test file with the test for the given file
+ *
+ * @param {string} fileRelativePath - The relative path of the file
+ * @param {string} testFile - The test file
+ * @param {ScreenSize[]} screenSizes - The screen sizes
+ */
+function appendTestFile(fileRelativePath, testFile, screenSizes) {
+  if (screenSizes.length > 0) {
+    screenSizes.forEach((screenSize) => {
+      testFile += `\ntest('${fileRelativePath.replace("index", "")} screen-${screenSize}', async () => {
+        await page${screenSize.toUpperCase()}.goto(\`\${baseUrl}${fileRelativePath.replace("index", "")}\`);
+        await delay(SCREENSHOT_DELAY);
+        await page${screenSize.toUpperCase()}.waitForLoadState('domcontentloaded');
+        const screenshot = await page${screenSize.toUpperCase()}.screenshot({ fullPage: true });
+        expect(screenshot).toMatchSnapshot();
+      });\n`;
+    });
+  } else {
+    testFile += `\ntest('${fileRelativePath.replace("index", "")}', async () => {
+      await page.goto(\`\${baseUrl}${fileRelativePath.replace("index", "")}\`);
+      await delay(SCREENSHOT_DELAY);
+      await page.waitForLoadState('domcontentloaded');
+      const screenshot = await page.screenshot({ fullPage: true });
+      expect(screenshot).toMatchSnapshot();
+    });\n`;
+  }
+
+  return testFile;
+}
+
+/**
+ * Generate browser contexts
+ *
+ * @param {ScreenSize[]} screenSizes - The screen sizes
+ */
+function generateBrowserContexts(screenSizes) {
+  let viewportSizes = "";
+  if (screenSizes.length > 0) {
+    screenSizes.forEach((screenSize) => {
+      viewportSizes += `\n// Create a context with "${screenSize}" screen size
+      const context${screenSize.toUpperCase()} = await browser.newContext({
+        viewport: { width: ${SCREEN_SIZES[screenSize].width}, height: ${SCREEN_SIZES[screenSize].height} },
+        deviceScaleFactor: ${SCREEN_SIZES[screenSize].deviceScaleFactor},
+      });\n`;
+    });
+  } else {
+    viewportSizes += `// Create a context with default screen size
+    const context = await browser.newContext();\n`;
+  }
+
+  return viewportSizes;
+}
+
+/**
+ * Initialize pages
+ *
+ * @param {ScreenSize[]} screenSizes - The screen sizes
+ */
+function initializePages(screenSizes) {
+  let initializePages = "";
+  if (screenSizes.length > 0) {
+    screenSizes.forEach((screenSize) => {
+      initializePages += `let page${screenSize.toUpperCase()};\n`;
+    });
+  } else {
+    initializePages += "let page;\n";
+  }
+
+  return initializePages;
+}
+
+/**
+ * Generate new pages
+ *
+ * @param {ScreenSize[]} screenSizes - The screen sizes
+ */
+function generateNewPages(screenSizes) {
+  let newPages = "";
+  if (screenSizes.length > 0) {
+    screenSizes.forEach((screenSize) => {
+      newPages += `page${screenSize.toUpperCase()} = await context${screenSize.toUpperCase()}.newPage();\n`;
+    });
+  } else {
+    newPages += "page = await context.newPage();\n";
+  }
+
+  return newPages;
+}
+
+/**
+ * Generate pages test file
+ *
+ * @param {string} projectFolder - The project folder
+ * @param {string} [pagesPath="pages"] - The pages path
+ * @param {string} [baseUrl="http://localhost:3000"] - The base URL
+ * @param {string} [testFileName="index.spec.ts"] - The test file name
+ * @param {ScreenSize[]} [screenSizes=[]] - The screen sizes
+ */
+function generatePagesTestFile(
+  projectFolder,
+  pagesPath = "pages",
+  baseUrl = "http://localhost:3000",
+  testFileName = "index.spec.ts",
+  screenSizes = [],
+) {
+  let pagesFullPath = "";
+  if (fs.existsSync(path.join(projectFolder, pagesPath))) {
+    pagesFullPath = path.join(projectFolder, pagesPath);
+  } else if (fs.existsSync(path.join(projectFolder, "src", pagesPath))) {
+    pagesFullPath = path.join(projectFolder, `src/${pagesPath}`);
+  }
+  let testFile = `import { test, expect } from '@playwright/test';
+import { chromium } from 'playwright';
+
+const baseUrl = '${baseUrl}';
+const SCREENSHOT_DELAY = 2000;
+
+test.describe('/pages', () => {
+  let browser;
+${initializePages(screenSizes)}
+
+  const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
+
+  test.beforeAll(async () => {
+    // Wait until yarn start is loaded
+    test.setTimeout(60000);
+    await delay(30000);
+    browser = await chromium.launch();
+    ${generateBrowserContexts(screenSizes)}
+${generateNewPages(screenSizes)}
+  });
+
+  test.afterAll(async () => {
+    await browser.close();
+  });
+`;
+
+  const pagesPathRegex = new RegExp(
+    `.*${pagesFullPath.replace("/", "\\/")}(.*)`,
+  );
+  glob
+    .sync(`${pagesFullPath}/**/*.@(${FILE_EXTENSIONS.join("|")})`)
+    .forEach((fileFullPath) => {
+      const fileRelativePath = fileFullPath.replace(pagesPathRegex, "$1");
+      const pageFileName = fileRelativePath.substring(
+        fileRelativePath.lastIndexOf("/") + 1,
+      );
+      // Check of the file starts with letter or digit
+      if (/^[a-zA-Z0-9]/.test(pageFileName)) {
+        testFile = appendTestFile(
+          fileRelativePath.replace(/\.[^/.]+$/, ""),
+          testFile,
+          screenSizes,
+        );
+      }
+    });
+  testFile += "\n});";
+  fs.writeFileSync(path.join(projectFolder, testFileName), testFile);
+}
+
+export default generatePagesTestFile;

package/lib/test/init.js

@@ -1,131 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const glob = require('glob');
-
-const FILE_EXTENSIONS = ['js', 'jsx', 'ts', 'tsx'];
-
-const SCREEN_SIZES = {
-  'xs': { width: 375, height: 667, deviceScaleFactor: 1 },
-  'lg': { width: 1280, height: 720, deviceScaleFactor: 2 }
-}
-
-const appendTestFile = (fileRelativePath, testFile, screenSizes) => {
-  if (screenSizes.length > 0) {
-    screenSizes.forEach((screenSize) => {
-      testFile += `\ntest('${fileRelativePath.replace('index', '')} screen-${screenSize}', async () => {
-        await page${screenSize.toUpperCase()}.goto(\`\${baseUrl}${fileRelativePath.replace('index', '')}\`);
-        await delay(SCREENSHOT_DELAY);
-        await page${screenSize.toUpperCase()}.waitForLoadState('domcontentloaded');
-        const screenshot = await page${screenSize.toUpperCase()}.screenshot({ fullPage: true });
-        expect(screenshot).toMatchSnapshot();
-      });\n`;
-    });
-  }
-  else {
-    testFile += `\ntest('${fileRelativePath.replace('index', '')}', async () => {
-      await page.goto(\`\${baseUrl}${fileRelativePath.replace('index', '')}\`);
-      await delay(SCREENSHOT_DELAY);
-      await page.waitForLoadState('domcontentloaded');
-      const screenshot = await page.screenshot({ fullPage: true });
-      expect(screenshot).toMatchSnapshot();
-    });\n`;
-  }
-  
-  return testFile;
-}
-
-const generateBrowserContexts = (screenSizes) => {
-  let viewportSizes = '';
-  if (screenSizes.length > 0) {
-    screenSizes.forEach((screenSize) => {
-      viewportSizes += `\n// Create a context with "${screenSize}" screen size
-      const context${screenSize.toUpperCase()} = await browser.newContext({
-        viewport: { width: ${SCREEN_SIZES[screenSize].width}, height: ${SCREEN_SIZES[screenSize].height} },
-        deviceScaleFactor: ${SCREEN_SIZES[screenSize].deviceScaleFactor},
-      });\n`;
-    });
-  }
-  else {
-    viewportSizes += `// Create a context with default screen size
-    const context = await browser.newContext();\n`;
-  }
-  
-  return viewportSizes;
-}
-
-const initializePages = (screenSizes) => {
-  let initializePages = '';
-  if (screenSizes.length > 0) {
-    screenSizes.forEach((screenSize) => {
-      initializePages += `let page${screenSize.toUpperCase()};\n`;
-    });
-  }
-  else {
-    initializePages += 'let page;\n';
-  }
-  
-  return initializePages;
-}
-
-const generateNewPages = (screenSizes) => {
-  let newPages = '';
-  if (screenSizes.length > 0) {
-    screenSizes.forEach((screenSize) => {
-      newPages += `page${screenSize.toUpperCase()} = await context${screenSize.toUpperCase()}.newPage();\n`;
-    });
-  }
-  else {
-    newPages += 'page = await context.newPage();\n';
-  }
-  
-  return newPages;
-}
-
-const generatePagesTestFile = (projectFolder, pagesPath = 'pages', baseUrl = 'http://localhost:3000', testFileName = 'index.spec.ts', screenSizes = []) => {
-  let pagesFullPath = '';
-  if (fs.existsSync(path.join(projectFolder, pagesPath))) {
-    pagesFullPath = path.join(projectFolder, pagesPath);
-  }
-  else if (fs.existsSync(path.join(projectFolder, 'src', pagesPath))) {
-    pagesFullPath = path.join(projectFolder, `src/${pagesPath}`);
-  }
-  let testFile = `import { test, expect } from '@playwright/test';
-import { chromium } from 'playwright';
-
-const baseUrl = '${baseUrl}';
-const SCREENSHOT_DELAY = 2000;
-
-test.describe('/pages', () => {
-  let browser;
-${initializePages(screenSizes)}
-
-  const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
-
-  test.beforeAll(async () => {
-    // Wait until yarn start is loaded
-    test.setTimeout(60000);
-    await delay(30000);
-    browser = await chromium.launch();
-    ${generateBrowserContexts(screenSizes)}
-${generateNewPages(screenSizes)}
-  });
-
-  test.afterAll(async () => {
-    await browser.close();
-  });
-`;
-
-  const pagesPathRegex = new RegExp(`.*${pagesFullPath.replace('/', '\\/')}(.*)`);
-  glob.sync(`${pagesFullPath}/**/*.@(${FILE_EXTENSIONS.join('|')})`).forEach((fileFullPath) => {
-    const fileRelativePath = fileFullPath.replace(pagesPathRegex, '$1');
-    const pageFileName = fileRelativePath.substring(fileRelativePath.lastIndexOf('/') + 1);
-    // Check of the file starts with letter or digit
-    if(/^[a-zA-Z0-9]/.test(pageFileName)) {
-      testFile = appendTestFile(fileRelativePath.replace(/\.[^/.]+$/, ''), testFile, screenSizes);
-    }
-  });
-  testFile += '\n});';
-  fs.writeFileSync(path.join(projectFolder, testFileName), testFile);
-}
-
-module.exports = generatePagesTestFile;

package/next.config.js

@@ -1 +0,0 @@
-module.exports = require('./next.common').config

package/nextrc.js

@@ -1,5 +0,0 @@
-const {makeConfig} = require('@digigov/cli/lib');
-
-module.exports = (overrides)=>{
-  return makeConfig(overrides, require('./next.common').config)
-}

package/postcss.config.js

@@ -1 +0,0 @@
-module.exports = require('./postcss.common').config

package/postcssrc.js

@@ -1,5 +0,0 @@
-const {makeConfig} = require('@digigov/cli/lib');
-
-module.exports = (overrides)=>{
-  return makeConfig(overrides, require('./postcss.common'))
-}

package/proxy-server.js

@@ -1,55 +0,0 @@
-/* eslint-disable no-console */
-const express = require('express');
-const next = require('next');
-const { resolveProject, extractCommandArgs } = require('@digigov/cli/lib');
-const project = resolveProject();
-const devProxy = project.digigov.proxy;
-const path = require('path');
-const port = parseInt(process.env.PORT, 10) || 3000;
-const env = process.env.NODE_ENV;
-const dev = env !== 'production';
-const conf = require(path.join(project.root, 'next.config.js'));
-const app = next({
-  dir: project.root, // base directory where everything is, could move to src later
-  dev,
-  conf,
-});
-const handle = app.getRequestHandler();
-
-const commandConfig = {
-  '-p': {
-    var: 'port',
-    type: Number,
-    default: 3000,
-  },
-};
-const commandArgs = process.argv.slice(2)
-const vars = extractCommandArgs(commandConfig, commandArgs)
-
-app
-  .prepare()
-  .then(() => {
-    const server = express();
-
-    // Set up the proxy.
-    if (dev && devProxy) {
-      const { createProxyMiddleware } = require('http-proxy-middleware');
-      Object.keys(devProxy).forEach(function(context) {
-        server.use(createProxyMiddleware(context, devProxy[context]));
-      });
-    }
-
-    // Default catch-all handler to allow Next.js to handle all other routes
-    server.all('*', (req, res) => handle(req, res));
-
-    server.listen(vars.port, err => {
-      if (err) {
-        throw err;
-      }
-      console.log(`> Ready on port ${port}`);
-    });
-  })
-  .catch(err => {
-    console.log('An error occurred, unable to start the server');
-    console.log(err);
-  });