chore: makes generated .mjs schemas smaller (#934)

## Description

- makes the generated (& distributed) .mjs version of the json schemas
smaller
- drive-by: removes type definitions in src (internal, not useful for
api users) from distribution
- drive-by: copy edits the default config template (making it smaller &
a bit more readable in the process0).

## Motivation and Context

Trying to make the distribution as small as it can be, without resorting
to unreadable minified code.

## How Has This Been Tested?

- [x] green ci

## Screenshots

Differences are just a few %, but every byte helps. 

After:
package size: 161.8 kB (-1.8 kB)
unpacked size: 629.1 kB (-9.4 kB)

Before:
package size: 163.6 kB
unpacked size: 638.5 kB

## Types of changes

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Documentation only change
- [x] Refactor (non-breaking change which fixes an issue without
changing functionality)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)

## Checklist

- [x] 📖

  - My change doesn't require a documentation update, or ...
  - it _does_ and I have updated it

- [x] ⚖️
- The contribution will be subject to [The MIT
license](https://github.com/sverweij/dependency-cruiser/blob/main/LICENSE),
and I'm OK with that.
  - The contribution is my own original work.
- I am ok with the stuff in
[**CONTRIBUTING.md**](https://github.com/sverweij/dependency-cruiser/blob/main/.github/CONTRIBUTING.md).

package.json

@@ -127,6 +127,7 @@
  "configs/plugins/",
  "src",
  "!src/**/*.json",
+ "!src/**/*.ts",
  "!src/**/*.md",
  "!**/*.DS_Store",
  "types/**/*.d.mts",

src/cli/init-config/config-template.mjs

@@ -136,7 +136,7 @@ module.exports = {
  severity: 'error',
  from: {},
  to: {
- path: '[.](?:spec|test)[.](?:js|mjs|cjs|jsx|ts|mts|cts|tsx|ls|coffee|litcoffee|coffee[.]md)$'
+ path: '[.](?:spec|test)[.](?:js|mjs|cjs|jsx|ts|mts|cts|tsx)$'
  }
  },
  {
@@ -150,7 +150,7 @@ module.exports = {
  'from.pathNot re of the not-to-dev-dep rule in the dependency-cruiser configuration',
  from: {
  path: '{{sourceLocationRE}}',
- pathNot: '[.](?:spec|test)[.](?:js|mjs|cjs|jsx|ts|mts|cts|tsx|ls|coffee|litcoffee|coffee[.]md)$'
+ pathNot: '[.](?:spec|test)[.](?:js|mjs|cjs|jsx|ts|mts|cts|tsx)$'
  },
  to: {
  dependencyTypes: [
@@ -216,12 +216,6 @@ module.exports = {
  */
  // includeOnly : [''],
 
- /* dependency-cruiser will include modules matching against the focus
- regular expression in its output, as well as their direct neighbours 
- (dependencies and dependents)
- */
- // focus : '',
-
  /* List of module systems to cruise.
  When left out dependency-cruiser will fall back to the list of _all_
  module systems it knows of. It's the default because it's the safe option
@@ -234,7 +228,7 @@ module.exports = {
  
  // moduleSystems: ['cjs', 'es6'],
 
- /* prefix for links in html and svg output (e.g. 'https://github.com/you/yourrepo/blob/develop/'
+ /* prefix for links in html and svg output (e.g. 'https://github.com/you/yourrepo/blob/main/'
  to open it on your online repo or \`vscode://file/$\{process.cwd()}/\` to 
  open it in visual studio code),
  */
@@ -277,15 +271,14 @@ module.exports = {
  to dependency-cruiser's current working directory. When not provided defaults
  to './webpack.conf.js'.
 
- The (optional) \`env\` and \`arguments\` attributes contain the parameters to be passed if
- your webpack config is a function and takes them (see webpack documentation
- for details)
+ The (optional) \`env\` and \`arguments\` attributes contain the parameters
+ to be passed if your webpack config is a function and takes them (see 
+  webpack documentation for details)
  */
  {{webpackConfigAttribute}}
 
  /* Babel config ('.babelrc', '.babelrc.json', '.babelrc.json5', ...) to use
- for compilation (and whatever other naughty things babel plugins do to
- source code).
+ for compilation
  */
  {{babelConfigAttribute}}
 
@@ -313,21 +306,20 @@ module.exports = {
  /*
  The extensions, by default are the same as the ones dependency-cruiser
  can access (run \`npx depcruise --info\` to see which ones that are in
- _your_ environment. If that list is larger than you need you can pass
+ _your_ environment). If that list is larger than you need you can pass
  the extensions you actually use (e.g. [".js", ".jsx"]). This can speed
- up the most expensive step in dependency cruising (module resolution)
- quite a bit.
+ up module resolution, which is the most expensive step.
  */
  {{extensionsAttribute}}
  /* What to consider a 'main' field in package.json */
  {{mainFieldsAttribute}}
  /*
  A list of alias fields in package.jsons
  See [this specification](https://github.com/defunctzombie/package-browser-field-spec) and
- the [resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealiasfields)
- documentation in the webpack docs. 
+ the webpack [resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealiasfields)
+ documentation 
  
- Defaults to an empty array (don't use any alias fields).
+ Defaults to an empty array (= don't use alias fields).
  */
  // aliasFields: ["browser"],
  },
@@ -336,21 +328,19 @@ module.exports = {
  /* pattern of modules that can be consolidated in the detailed
  graphical dependency graph. The default pattern in this configuration
  collapses everything in node_modules to one folder deep so you see
- the external modules, but not the innards your app depends upon.
+ the external modules, but their innards.
  */
  collapsePattern: 'node_modules/(?:@[^/]+/[^/]+|[^/]+)',
 
  /* Options to tweak the appearance of your graph.See
  https://github.com/sverweij/dependency-cruiser/blob/main/doc/options-reference.md#reporteroptions
  for details and some examples. If you don't specify a theme
- don't worry - dependency-cruiser will fall back to the default one.
+ dependency-cruiser falls back to a built-in one.
  */
  // theme: {
  // graph: {
- // /* splines: "ortho" will give you straight lines at the expense of
- // being slow to render on big graphs
- // splines: "true" will give you bezier curves which are faster
- // but might not look as nice
+ // /* splines: "ortho" gives straight lines, but is slow on big graphs
+ // splines: "true" gives bezier curves (fast, not as nice as ortho)
  // */
  // splines: "true"
  // },
@@ -364,14 +354,11 @@ module.exports = {
  */
  collapsePattern: '^(?:packages|src|lib(s?)|app(s?)|bin|test(s?)|spec(s?))/[^/]+|node_modules/(?:@[^/]+/[^/]+|[^/]+)',
 
- /* Options to tweak the appearance of your graph.See
- https://github.com/sverweij/dependency-cruiser/blob/main/doc/options-reference.md#reporteroptions
- for details and some examples. If you don't specify a theme
- for 'archi' dependency-cruiser will use the one specified in the
+ /* Options to tweak the appearance of your graph. If you don't specify a
+ theme for 'archi' dependency-cruiser will use the one specified in the
  dot section above and otherwise use the default one.
  */
- // theme: {
- // },
+ // theme: { },
  },
  "text": {
  "highlightFocused": true

src/main/index.d.ts

@@ -1,4 +1 @@
-// workaround to nodenext shenanigans with the TypeScript compiler
-// see https://github.com/sverweij/dependency-cruiser/issues/754
-// eslint-disable-next-line node/no-unpublished-import
 export type * from "../../types/dependency-cruiser.mjs";

src/validate/index.d.ts

@@ -1,4 +1,3 @@
-/* eslint-disable node/no-unpublished-import */
 import type {
  IDependency,
  IFolder,
@@ -37,7 +36,7 @@ export interface IValidationResult {
  */
 export function module(
  pRuleSet: IFlattenedRuleSet,
- pModule: IModule
+ pModule: IModule,
 ): IValidationResult;
 
 /**
@@ -47,7 +46,7 @@ export function module(
 export function dependency(
  pRuleSet: IFlattenedRuleSet,
  pFrom: IModule,
- pTo: IDependency
+ pTo: IDependency,
 ): IValidationResult;
 
 /**
@@ -57,5 +56,5 @@ export function dependency(
 export function folder(
  pRuleSet: IFlattenedRuleSet,
  pFromFolder: IFolder,
- pToFolder: IFolderDependency
+ pToFolder: IFolderDependency,
 ): IValidationResult;

tools/generate-schemas.utl.mjs

@@ -2,6 +2,7 @@
 import { writeFileSync } from "node:fs";
 import { extname } from "node:path";
 import prettier from "prettier";
+import babel from "@babel/core";
 
 function stripAttribute(pObject, pAttribute) {
  const lObject = structuredClone(pObject);
@@ -19,23 +20,23 @@ function stripAttribute(pObject, pAttribute) {
 function emitConsolidatedSchema(pOutputFileName) {
  if (extname(pOutputFileName) === ".json") {
  return async (pJSONSchemaObject) => {
- const lData = await prettier.format(
+ const lFormattedJSON = await prettier.format(
  JSON.stringify(pJSONSchemaObject.default),
  {
  parser: "json",
  },
  );
- writeFileSync(pOutputFileName, lData, "utf8");
+ writeFileSync(pOutputFileName, lFormattedJSON, "utf8");
  };
  }
- return (pJSONSchemaObject) => {
- writeFileSync(
- pOutputFileName,
-  `/* generated - don't edit */export default ${JSON.stringify(
-  stripAttribute(pJSONSchemaObject.default, "description"),
-  )}`,
-  "utf8",
- );
+ return async (pJSONSchemaObject) => {
+ const lUnMinified = `/* generated - don't edit */export default ${JSON.stringify(
+ stripAttribute(pJSONSchemaObject.default, "description"),
+ )}`;
+ // to strip quoted attributes {"thing": 481} => {thing: 481}
+ const lFormatted = await prettier.format(lUnMinified, { parser: "babel" });
+ const lMinified = babel.transformSync(lFormatted, { minified: true }).code;
+ writeFileSync(pOutputFileName, lMinified, "utf8");
  };
 }