chore: change distribution files structure

jorgecasar · jorgecasar · commit 172db25ac9e5 · 2023-06-14T17:08:33.000+02:00
BREAKING CHANGE: The directory structure for distributable files has changed to improve compatibility with npm package managers.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,8 @@ outputTest
 input
 coverage
 dist
+src/**/*.d.ts
+src/**/*.d.ts.map
+src/**/*.js
+src/**/*.js.map
+*.tsbuildinfo
diff --git a/package.json b/package.json
@@ -11,22 +11,22 @@
     "generator"
   ],
   "license": "Mozilla Public License 2.0",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "bin": "dist/index.js",
+  "type": "commonjs",
+  "main": "src/index.js",
+  "bin": "src/index.js",
   "files": [
-    "dist",
+    "src/**/*.{d.ts,d.ts.map,js,js.map}",
     "CONTRIBUTING.md",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
     "test": "jest",
     "coverage": "jest --coverage",
-    "clean": "rm -rf build output",
+    "clean": "rm -rf output",
     "build": "tsc",
     "prepublishOnly": "npm run build",
-    "start": "node build/openapi-nodejs-cli/index.js",
+    "start": "node ./index.js",
     "format": "prettier --write .",
     "lint": "eslint src/**/*.ts",
     "fix": "eslint src/**/*.ts --fix"
diff --git a/src/tests/helpers/capitalize.spec.ts b/src/tests/helpers/capitalize.spec.ts
@@ -3,7 +3,7 @@
  *  License, v. 2.0. If a copy of the MPL was not distributed with this
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { capitalize } from "./";
+import { capitalize } from "../../helpers/capitalize.js";
 
 describe("capitalize()", () => {
   describe('passing "name"', () => {
diff --git a/src/tests/helpers/divideIntoDocumentsByTag.spec.ts b/src/tests/helpers/divideIntoDocumentsByTag.spec.ts
@@ -3,10 +3,10 @@
  *  License, v. 2.0. If a copy of the MPL was not distributed with this
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { DataObjectWith2Tags } from "../../mocks/DataObjectWith2Tags";
-import { DataObjectWithoutTags } from "../../mocks/DataObjectWithoutTags";
+import { DataObjectWith2Tags } from "../mocks/DataObjectWith2Tags.js";
+import { DataObjectWithoutTags } from "../mocks/DataObjectWithoutTags.js";
 
-import { divideIntoDocumentsByTag } from "./divideIntoDocumentsByTag";
+import { divideIntoDocumentsByTag } from "../../helpers/divideIntoDocumentsByTag.js";
 
 describe("divideIntoDocumentsByTag()", () => {
   describe("passing sample DataObject with 2 different tags", () => {
diff --git a/src/tests/helpers/getComponentPath.spec.ts b/src/tests/helpers/getComponentPath.spec.ts
@@ -4,7 +4,7 @@
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-import { getComponentPath } from "./getComponentPath";
+import { getComponentPath } from "../../helpers/getComponentPath.js";
 
 describe("getComponentPath()", () => {
   describe("when $ref has no schema", () => {
diff --git a/src/tests/helpers/getComponentsFiles.spec.ts b/src/tests/helpers/getComponentsFiles.spec.ts
@@ -4,8 +4,8 @@
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 import axios, { AxiosRequestConfig } from "axios";
-import fs, { PathOrFileDescriptor } from "fs";
-import { getComponentsFiles } from "./getComponentsFiles";
+import fs, { PathOrFileDescriptor } from "node:fs";
+import { getComponentsFiles } from "../../helpers/getComponentsFiles.js";
 
 describe("getComponentsFiles()", () => {
   describe("passing an URL", () => {
diff --git a/src/tests/helpers/hasRepeatedOperationIdErrors.spec.ts b/src/tests/helpers/hasRepeatedOperationIdErrors.spec.ts
@@ -3,9 +3,9 @@
  *  License, v. 2.0. If a copy of the MPL was not distributed with this
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { DocumentListWithNoRepeatedOperationIds } from "../../mocks/DocumentListWithNoRepeatedOperationIds";
-import { DocumentListWithRepeatedOperationIds } from "../../mocks/DocumentListWithRepeatedOperationIds";
-import { hasRepeatedOperationIdErrors } from "./hasRepeatedOperationIdErrors";
+import { DocumentListWithNoRepeatedOperationIds } from "../mocks/DocumentListWithNoRepeatedOperationIds.js";
+import { DocumentListWithRepeatedOperationIds } from "../mocks/DocumentListWithRepeatedOperationIds.js";
+import { hasRepeatedOperationIdErrors } from "../../helpers/hasRepeatedOperationIdErrors.js";
 
 describe("checkRepeatedOperationIdErrors()", () => {
   describe("passing sample DataObject without repeated operationIds", () => {
diff --git a/src/tests/helpers/isUrl.spec.ts b/src/tests/helpers/isUrl.spec.ts
@@ -3,7 +3,7 @@
  *  License, v. 2.0. If a copy of the MPL was not distributed with this
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { isUrl } from "./isUrl";
+import { isUrl } from "../../helpers/isUrl.js";
 
 describe("isUrl()", () => {
   describe("passing http url", () => {
diff --git a/src/tests/helpers/log.spec.ts b/src/tests/helpers/log.spec.ts
@@ -3,7 +3,7 @@
  *  License, v. 2.0. If a copy of the MPL was not distributed with this
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { log } from "./log";
+import { log } from "../../helpers/log.js";
 
 describe("log()", () => {
   it("console.log has been called", () => {
diff --git a/src/tests/helpers/parseTypes.spec.ts b/src/tests/helpers/parseTypes.spec.ts
@@ -3,7 +3,7 @@
  *  License, v. 2.0. If a copy of the MPL was not distributed with this
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { parseTypes } from "./parseTypes";
+import { parseTypes } from "../../helpers/parseTypes.js";
 
 describe("parseTypes()", () => {
   describe("references to a component", () => {
diff --git a/src/tests/helpers/resolveSchemaName.spec.ts b/src/tests/helpers/resolveSchemaName.spec.ts
@@ -3,7 +3,7 @@
  *  License, v. 2.0. If a copy of the MPL was not distributed with this
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { resolveSchemaName } from "./resolveSchemaName";
+import { resolveSchemaName } from "../../helpers/resolveSchemaName.js";
 
 describe("resolveSchemaName()", () => {
   describe("passing a ref", () => {
diff --git a/src/tests/helpers/toPascalCase.spec.ts b/src/tests/helpers/toPascalCase.spec.ts
@@ -3,7 +3,7 @@
  *  License, v. 2.0. If a copy of the MPL was not distributed with this
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import { toPascalCase } from "./toPascalCase";
+import { toPascalCase } from "../../helpers/toPascalCase.js";
 
 describe("toPascalCase()", () => {
   describe('passing "name of the variable"', () => {
diff --git a/src/tests/helpers/writeOutputFile.spec.ts b/src/tests/helpers/writeOutputFile.spec.ts
@@ -3,8 +3,8 @@
  *  License, v. 2.0. If a copy of the MPL was not distributed with this
  *  file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
-import fs from "fs";
-import { writeOutputFile } from "./writeOutputFile";
+import fs from "node:fs";
+import { writeOutputFile } from "../../helpers/writeOutputFile.js";
 
 describe("writeOutputFile()", () => {
   describe("when output directory does not exists", () => {
diff --git a/src/tests/mocks/DataObjectWith2Tags.ts b/src/tests/mocks/DataObjectWith2Tags.ts
diff --git a/src/tests/mocks/DataObjectWithoutTags.ts b/src/tests/mocks/DataObjectWithoutTags.ts
diff --git a/src/tests/mocks/DocumentListWithNoRepeatedOperationIds.ts b/src/tests/mocks/DocumentListWithNoRepeatedOperationIds.ts
diff --git a/src/tests/mocks/DocumentListWithRepeatedOperationIds.ts b/src/tests/mocks/DocumentListWithRepeatedOperationIds.ts
diff --git a/tsconfig.json b/tsconfig.json
@@ -12,7 +12,9 @@
 
     /* Language and Environment */
     "target": "ESNext" /* 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. */
+    "lib": [
+      "ESNext"
+    ] /* 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 TC39 stage 2 draft decorators. */
     // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
@@ -24,9 +26,9 @@
     // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
 
     /* Modules */
-    "module": "commonjs" /* Specify what module code is generated. */,
-    "rootDir": "./src" /* Specify the root folder within your source files. */,
-    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    "module": "CommonJS" /* 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. */
@@ -38,16 +40,17 @@
 
     /* 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. */
+    "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. */
+    "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. */
-    // "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": "./dist" /* Specify an output folder for all emitted 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. */
