built the foundation for development

CHANGELOG.md

@@ -0,0 +1,9 @@
+### Changelog
+
+All notable changes to this project will be documented in this file. Dates are displayed in UTC.
+
+Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
+
+#### 0.0.2
+
+- init [`4d2ac8f`](https://github.com/izelnakri/qunitx-cli/commit/4d2ac8fd98ce7a4c988f9036064a6ef592b55f8f)

Dockerfile

@@ -0,0 +1,24 @@
+FROM node:20.4.0-slim
+
+ENV PUPPETEER_SKIP_DOWNLOAD=true CHROME_BIN=/usr/bin/google-chrome-stable
+
+RUN apt-get update \
+    && apt-get install -y wget gnupg \
+    && wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
+    && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
+    && apt-get update \
+    && apt-get install -y git libxshmfence-dev google-chrome-stable --no-install-recommends \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /code/
+
+ADD package.json package-lock.json /code/
+
+RUN npm install
+
+ADD lib /code/lib
+ADD vendor /code/vendor
+ADD test /code/test
+ADD . /code/
+
+ENTRYPOINT "/bin/bash"

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Izel Nakri and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

build.js

@@ -1 +1,54 @@
-console.log('TODO: build.js');
+import fs from 'fs/promises';
+
+let [qunitJS, qunitCSS, _] = await Promise.all([
+  fs.readFile('./node_modules/qunit/qunit/qunit.js'),
+  fs.readFile('./node_modules/qunit/qunit/qunit.css'),
+  fs.mkdir('./vendor', { recursive: true })
+]);
+
+let newQUnit = qunitJS.toString().replace(
+  'start: function start(count) {',
+  `reset: function() {
+		ProcessingQueue.finished = false;
+		globalStartCalled = false;
+		runStarted = false;
+
+		config.queue.length = 0;
+		config.modules.length = 0;
+		config.autostart = false;
+
+    Object.assign(config.stats, { total: 0, passed: 0, failed: 0, skipped: 0, todo: 0 });
+
+		[
+			"started", "updateRate", "filter", "depth", "current",
+			"pageLoaded", "timeoutHandler", "timeout", "pollution"
+		].forEach( ( key ) => delete config[ key ] );
+
+		const suiteReport = config.currentModule.suiteReport;
+
+		suiteReport.childSuites.length = 0;
+		delete suiteReport._startTime;
+		delete suiteReport._endTime;
+
+		config.modules.push( config.currentModule );
+  },
+  start: function start(count) {`);
+
+await Promise.all([
+  fs.writeFile('./vendor/qunit.js', newQUnit),
+  fs.writeFile('./vendor/qunit.css', qunitCSS),
+  createPackageJSONIfNotExists()
+]);
+
+async function createPackageJSONIfNotExists() {
+  try {
+    await fs.stat('./vendor/package.json');
+
+    return true;
+  } catch (error) {
+    await fs.writeFile('./vendor/package.json', JSON.stringify({
+      name: 'qunitx-vendor',
+      version: '0.0.1'
+    }));
+  }
+}

cli.js

@@ -1,2 +1,25 @@
 #!/usr/bin/env -S TS_NODE_COMPILER_OPTIONS='{"module":"ES2020"}' node --loader ts-node/esm/transpile-only
-console.log('Future QUnitX CLI');
+import process from 'node:process';
+import displayHelpOutput from './lib/commands/help.js';
+import initializeProject from './lib/commands/init.js';
+import generateTestFiles from './lib/commands/generate.js';
+import run from './lib/commands/run.js';
+import setupConfig from './lib/setup/config.js';
+
+process.title = 'qunitx';
+
+(async () => {
+  if (!process.argv[2]) {
+    return await displayHelpOutput();
+  } else if (['help', 'h', 'p', 'print'].includes(process.argv[2])) {
+    return await displayHelpOutput();
+  } else if (['new', 'n', 'g', 'generate'].includes(process.argv[2])) {
+    return await generateTestFiles();
+  } else if (['init'].includes(process.argv[2])) {
+    return await initializeProject();
+  }
+
+  let config = await setupConfig();
+
+  return await run(config);
+})();

lib/boilerplates/default-project-config-values.js

@@ -0,0 +1,6 @@
+export default {
+  output: 'tmp',
+  timeout: 20000,
+  failFast: false,
+  port: 1234
+}

lib/boilerplates/setup/tests.hbs

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <title>{{applicationName}} Tests</title>
+    <link href="../node_modules/qunitx/vendor/qunit.css" rel="stylesheet">
+  </head>
+  <body>
+    <div id="qunit"></div>
+    <div id="qunit-fixture"></div>
+
+    {{content}}
+  </body>
+</html>

lib/boilerplates/setup/tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "NodeNext",                                /* Specify what module code is generated. */
+    // "rootDir": ".",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "NodeNext",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}

lib/boilerplates/test.js

@@ -0,0 +1,25 @@
+import { module, test } from 'qunitx';
+
+module('{{moduleName}}', function(hooks) {
+  test('assert true works', function (assert) {
+    assert.expect(3);
+    assert.ok(true);
+    assert.equal(true, true);
+    assert.deepEqual({}, {});
+  });
+
+  test('async test finishes', async function (assert) {
+    assert.expect(3);
+
+    let wait = () => new Promise((resolve, reject) => {
+      setTimeout(() => resolve(true), 50);
+    });
+    let result = await wait();
+
+    assert.ok(true);
+    assert.equal(true, result);
+
+    await wait();
+    assert.equal(true, result);
+  });
+});

lib/commands/generate.js

@@ -0,0 +1,33 @@
+import fs from 'node:fs/promises';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import kleur from 'kleur';
+import findProjectRoot from '../utils/find-project-root.js';
+import pathExists from '../utils/path-exists.js';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default async function() {
+  let projectRoot = await findProjectRoot();
+  let moduleName = process.argv[3]; // TODO: classify this maybe in future
+  let path = process.argv[3].endsWith('.js') || process.argv[3].endsWith('.ts')
+    ? `${projectRoot}/${process.argv[3]}`
+    : `${projectRoot}/${process.argv[3]}.js`;
+
+  if (await pathExists(path)) {
+    return console.log(`${path} already exists!`);
+  }
+
+  let testJSContent = await fs.readFile(`${__dirname}/../boilerplates/test.js`);
+  let targetFolderPaths = path.split('/');
+
+  targetFolderPaths.pop();
+
+  await fs.mkdir(targetFolderPaths.join('/'), { recursive: true });
+  await fs.writeFile(
+    path,
+    testJSContent.toString().replace('{{moduleName}}', moduleName)
+  );
+
+  console.log(kleur.green(`${path} written`));
+}