@digigov/cli-app 1.2.3 → 2.0.0-0138f8bd

package/common.js

@@ -0,0 +1,4 @@
+export const EXEC_CONFIG = {
+  extendEnv: false,
+  stdio: 'inherit',
+};

package/eslint.config.js

@@ -0,0 +1,3 @@
+import config from '@digigov/cli-lint/eslint.config';
+
+export default [...config];

package/index.js

@@ -1,87 +1,22 @@
-const { flags } = require('@oclif/command')
-const execa = require('execa')
-const fs = require('fs')
-const { resolveProject, makeConfig, DigigovCommand } = require('@digigov/cli/lib')
-const path = require('path');
-const yargs = require('yargs');
-const execConfig = { env: {}, stdio: 'inherit' }
-const generatePagesTestFile = require('./lib/test/init.js')
-module.exports = class App extends DigigovCommand {
-  static description = 'app digigov projects'
-  static id = 'app'
-  static examples = [
-    `$ digigov app`,
-  ]
-  dirname = __dirname
-  static load() { return App }
-  script = 'next'
-  async run() {
-    const [command, ...args] = this.argv;
-    let proc;
-    const project = resolveProject();
-    switch (command) {
-      case 'export':
-        await this.exec('rimraf', ['out'])
-        await this.exec(this.script, ['build'])
-        proc = this.exec(this.script, [command, ...args], execConfig)
-        break;
-      case 'build':
-        await this.exec('rimraf', ['out'])
-        proc = this.exec(this.script, [command, ...args], execConfig)
-        break;
-      case 'start':
-        if (!fs.existsSync(path.join(project.root, '.next'))) {
-          await this.exec(this.script, ['build']);
-        }
-        proc = this.exec(this.script, [command, ...args], execConfig);
-        break;
-      case 'dev':
-        const digigov = project.digigov;
-        if (digigov && digigov.proxy) {
-          await execa('node', [path.resolve(__dirname, 'proxy-server.js')], execConfig);
-        }
-        proc = this.exec(this.script, [command, ...args], execConfig);
-        break;
-      case 'test':
-        const test_args = yargs
-          .option('init', {
-            alias: 'i',
-            describe: 'Initialize project with specified parameters'
-          })
-          .option('baseUrl', {
-            alias: 'b',
-            describe: 'The base url of the running project',
-            default: 'http://localhost:3000'
-          })
-          .option('pagesPath', {
-            alias: 'p',
-            describe: 'The directory where the pages are located relative to the project folder',
-            default: 'pages'
-          })
-          .option('screenSizes', {
-            alias: 's',
-            choices: ['xs', 'lg'],
-            describe: 'The screen sizes for viewport',
-          })
-          .help()
-          .argv;
+import { DigigovCommand, logger } from '@digigov/cli/lib';
 
-        if (test_args.init) {
-          const { baseUrl, pagesPath, screenSizes } = test_args;
-          console.log(`Generating test files for pagesPath "${pagesPath}" with baseUrl "${baseUrl}" for screen sizes "${screenSizes}"`);
-          const projectFolder = process.cwd();
-          generatePagesTestFile(projectFolder, pagesPath, baseUrl, screenSizes);
-        } else {
-          console.log('Usage: digigov app test --init --baseUrl [baseUrl] --pagesPath [pagesPath] --screenSizes [screenSizes]');
-          console.log('baseUrl: the base url of the running project (default: http://localhost:3000)');
-          console.log('pagesPath: the directory where the pages are located (default: pages, src/pages)');
-          console.log('screenSizes: the screen sizes for viewport (default: lg)');
-        }
-        break;
-      default:
-        console.error(`No command with name ${command}`)
-    }
-    return proc;
-  }
+import path from 'path';
+import { fileURLToPath } from 'url';
+import fs from 'fs';
+
+const command = new DigigovCommand('app', import.meta.url);
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const subcommandsDir = path.join(__dirname, 'subcommands');
+
+const subcommands = fs.readdirSync(subcommandsDir);
+for (const subcommand of subcommands) {
+  const subcommandPath = path.join(subcommandsDir, subcommand);
+  const subcommandModule = await import(subcommandPath);
+  command.addCommand(subcommandModule.default);
+  logger.debug(
+    `Loaded subcommand for cli-app: ${subcommand.replace('.js', '')}`
+  );
 }
 
+export default command;

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

@@ -1,8 +1,6 @@
-const path = require('path');
 const lib = require('@digigov/cli/lib');
-let aliases = lib.aliases(null, true);
+let aliases = lib.aliases(true);
 const withImages = require('next-images');
-const { makeBabelConfig } = require('@digigov/cli-build/babel.common');
 
 function makeNextConfig(dir) {
   const project = lib.resolveProject(dir);

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-0138f8bd",
   "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,46 @@
     "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-0138f8bd",
     "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",
-    "@types/node": "18.19.0",
-    "@types/react": "18.3.3",
+    "@digigov/cli": "2.0.0-0138f8bd",
+    "typescript": "5.6.2",
+    "@types/node": "20.17.24",
+    "@types/react": "19.1.3",
     "autoprefixer": "10.4.16",
     "postcss": "8.4.4",
-    "@digigov/css": "1.2.0",
-    "tailwindcss": "3.3.5"
+    "@digigov/css": "2.0.0-0138f8bd",
+    "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",
+    "@digigov/cli": "2.0.0-0138f8bd",
+    "@digigov/cli-lint": "2.0.0-0138f8bd",
+    "eslint": "9.16.0",
+    "prettier": "3.4.2"
   },
   "scripts": {
-    "publint": "publint"
+    "publint": "publint",
+    "lint": "digigov lint",
+    "typecheck": "tsc"
   }
-}
+}

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

@@ -1,6 +1,6 @@
 module.exports = {
   plugins: {
-    "tailwindcss/nesting": {},
+    'tailwindcss/nesting': {},
     tailwindcss: {},
     autoprefixer: {},
   },

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.common.cjs

@@ -0,0 +1,11 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  content: {
+    files: [
+      './src/**/*.{js,ts,jsx,tsx}',
+      './node_modules/@digigov/react-core/**/*.{js,ts,jsx,tsx}',
+    ],
+    relative: true,
+  },
+  plugins: [require('@digigov/css')],
+};

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,5 @@
+{
+  "extends": "@digigov/cli/tsconfig.cli",
+  "include": ["./*.js", "./subcommands", "./utils"],
+  "exclude": ["eslint.config.js", ".prettierrc.cjs"]
+}

package/{proxy-server.js → utils/proxy-server.js}

@@ -1,40 +1,35 @@
-/* eslint-disable no-console */
-const express = require('express');
-const next = require('next');
-const { resolveProject, extractCommandArgs } = require('@digigov/cli/lib');
+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 path = require('path');
-const port = parseInt(process.env.PORT, 10) || 3000;
-const env = process.env.NODE_ENV;
-const dev = env !== 'production';
+
+const require = createRequire(import.meta.url);
 const conf = require(path.join(project.root, 'next.config.js'));
-const app = next({
+
+const app = next.default({
   dir: project.root, // base directory where everything is, could move to src later
-  dev,
+  dev: isDev,
   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) {
+    if (isDev && devProxy) {
       const { createProxyMiddleware } = require('http-proxy-middleware');
-      Object.keys(devProxy).forEach(function(context) {
+      Object.keys(devProxy).forEach(function (context) {
         server.use(createProxyMiddleware(context, devProxy[context]));
       });
     }
@@ -42,14 +37,12 @@ app
     // 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;
-      }
+    server.listen(port, () => {
       console.log(`> Ready on port ${port}`);
     });
+    return;
   })
-  .catch(err => {
+  .catch((err) => {
     console.log('An error occurred, unable to start the server');
     console.log(err);
   });

package/{lib/test/init.js → utils/test-init.js}

@@ -1,15 +1,26 @@
-const fs = require('fs');
-const path = require('path');
-const glob = require('glob');
+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 }
-}
+  xs: { width: 375, height: 667, deviceScaleFactor: 1 },
+  lg: { width: 1280, height: 720, deviceScaleFactor: 2 },
+};
 
-const appendTestFile = (fileRelativePath, testFile, screenSizes) => {
+/**
+ * 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 () => {
@@ -20,8 +31,7 @@ const appendTestFile = (fileRelativePath, testFile, screenSizes) => {
         expect(screenshot).toMatchSnapshot();
       });\n`;
     });
-  }
-  else {
+  } else {
     testFile += `\ntest('${fileRelativePath.replace('index', '')}', async () => {
       await page.goto(\`\${baseUrl}${fileRelativePath.replace('index', '')}\`);
       await delay(SCREENSHOT_DELAY);
@@ -30,11 +40,16 @@ const appendTestFile = (fileRelativePath, testFile, screenSizes) => {
       expect(screenshot).toMatchSnapshot();
     });\n`;
   }
-  
+
   return testFile;
 }
 
-const generateBrowserContexts = (screenSizes) => {
+/**
+ * Generate browser contexts
+ *
+ * @param {ScreenSize[]} screenSizes - The screen sizes
+ */
+function generateBrowserContexts(screenSizes) {
   let viewportSizes = '';
   if (screenSizes.length > 0) {
     screenSizes.forEach((screenSize) => {
@@ -44,49 +59,70 @@ const generateBrowserContexts = (screenSizes) => {
         deviceScaleFactor: ${SCREEN_SIZES[screenSize].deviceScaleFactor},
       });\n`;
     });
-  }
-  else {
+  } else {
     viewportSizes += `// Create a context with default screen size
     const context = await browser.newContext();\n`;
   }
-  
+
   return viewportSizes;
 }
 
-const initializePages = (screenSizes) => {
+/**
+ * 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 {
+  } else {
     initializePages += 'let page;\n';
   }
-  
+
   return initializePages;
 }
 
-const generateNewPages = (screenSizes) => {
+/**
+ * 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 {
+  } else {
     newPages += 'page = await context.newPage();\n';
   }
-  
+
   return newPages;
 }
 
-const generatePagesTestFile = (projectFolder, pagesPath = 'pages', baseUrl = 'http://localhost:3000', testFileName = 'index.spec.ts', screenSizes = []) => {
+/**
+ * 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))) {
+  } else if (fs.existsSync(path.join(projectFolder, 'src', pagesPath))) {
     pagesFullPath = path.join(projectFolder, `src/${pagesPath}`);
   }
   let testFile = `import { test, expect } from '@playwright/test';
@@ -115,17 +151,27 @@ ${generateNewPages(screenSizes)}
   });
 `;
 
-  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);
-    }
-  });
+  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;
+export default 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'))
-}