@cparra/apexdocs 2.24.0 → 2.25.0-alpha.1

package/lib/util/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,wCAAwC;AAExC;;GAEG;AACH,MAAa,MAAM;IAKjB;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAAC,OAAe,EAAE,GAAG,IAAc;QAClD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,GAAG,IAAc;QACpD,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,WAAW,GAAG,IAAI,EAAE,QAAyB,OAAO,EAAE,eAAe,GAAG,IAAI;QAChH,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE;YACzB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;SACvB;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,IAAI,UAAU,CAAC;QACf,IAAI,KAAK,KAAK,OAAO,EAAE;YACrB,UAAU,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;SAC5E;aAAM;YACL,UAAU,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;SAC1E;QACD,IAAI,eAAe,EAAE;YACnB,SAAS,CAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;SACvC;aAAM;YACL,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;SAClD;IACH,CAAC;IAEM,MAAM,CAAC,KAAK;QACjB,SAAS,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;;AAjDH,wBAkDC;AAjDQ,mBAAY,GAAG,CAAC,CAAC,CAAC;AAElB,aAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC"}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,4DAAmC;AAEnC;;GAEG;AACH,MAAa,MAAM;IAKjB;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAAC,OAAe,EAAE,GAAG,IAAc;QAClD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,GAAG,IAAc;QACpD,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;YAChB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,WAAW,GAAG,IAAI,EAAE,QAAyB,OAAO,EAAE,eAAe,GAAG,IAAI;QAChH,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,IAAI,UAAU,CAAC;QACf,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;YACtB,UAAU,GAAG,GAAG,eAAK,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;QAC7E,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,GAAG,eAAK,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;QAC3E,CAAC;QACD,IAAI,eAAe,EAAE,CAAC;YACpB,IAAA,oBAAS,EAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,KAAK;QACjB,oBAAS,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;;AAjDH,wBAkDC;AAjDQ,mBAAY,GAAG,CAAC,CAAC,CAAC;AAElB,aAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC"}

package/lib/util/string-utils.d.ts

@@ -1,2 +1,2 @@
-export declare function truncate(str: string, n: number): string;
-export declare const camel2title: (camelCase: string) => string;
+export declare function truncate(str: string, n: number): string;
+export declare const camel2title: (camelCase: string) => string;

package/lib/util/string-utils.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.camel2title = exports.truncate = void 0;
-function truncate(str, n) {
-    return str.length > n ? str.substr(0, n - 1) + '…' : str;
-}
-exports.truncate = truncate;
-const camel2title = (camelCase) => camelCase
-    .replace(/\//g, ' ')
-    .replace(/([A-Z])/g, (match) => ` ${match}`)
-    .replace(/\b\w/g, (match) => match.toUpperCase())
-    .replace(/^./, (match) => match.toUpperCase())
-    .trim();
-exports.camel2title = camel2title;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.camel2title = void 0;
+exports.truncate = truncate;
+function truncate(str, n) {
+    return str.length > n ? str.substr(0, n - 1) + '…' : str;
+}
+const camel2title = (camelCase) => camelCase
+    .replace(/\//g, ' ')
+    .replace(/([A-Z])/g, (match) => ` ${match}`)
+    .replace(/\b\w/g, (match) => match.toUpperCase())
+    .replace(/^./, (match) => match.toUpperCase())
+    .trim();
+exports.camel2title = camel2title;
 //# sourceMappingURL=string-utils.js.map

package/lib/util/string-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"string-utils.js","sourceRoot":"","sources":["../../src/util/string-utils.ts"],"names":[],"mappings":";;;AAAA,SAAgB,QAAQ,CAAC,GAAW,EAAE,CAAS;IAC7C,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;AAClE,CAAC;AAFD,4BAEC;AAEM,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAE,EAAE,CAC/C,SAAS;KACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;KACnB,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;KAC3C,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KAChD,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KAC7C,IAAI,EAAE,CAAC;AANC,QAAA,WAAW,eAMZ"}
+{"version":3,"file":"string-utils.js","sourceRoot":"","sources":["../../src/util/string-utils.ts"],"names":[],"mappings":";;;AAAA,4BAEC;AAFD,SAAgB,QAAQ,CAAC,GAAW,EAAE,CAAS;IAC7C,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;AAClE,CAAC;AAEM,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAE,EAAE,CAC/C,SAAS;KACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;KACnB,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;KAC3C,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KAChD,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KAC7C,IAAI,EAAE,CAAC;AANC,QAAA,WAAW,eAMZ"}

package/package.json

@@ -1,78 +1,79 @@
-{
-  "name": "@cparra/apexdocs",
-  "version": "2.24.0",
-  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
-  "keywords": [
-    "apex",
-    "salesforce",
-    "documentation",
-    "cli",
-    "apex-docs",
-    "docs"
-  ],
-  "main": "lib/index.js",
-  "bin": {
-    "apexdocs-generate": "lib/cli/generate.js"
-  },
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "test": "jest --coverage",
-    "build": "rimraf ./lib && npm run lint && tsc --declaration",
-    "lint": "eslint \"./src/**/*.{js,ts}\" --quiet --fix",
-    "prepare": "npm run build",
-    "version": "npm run format && git add -A src",
-    "postversion": "git push && git push --tags",
-    "docs:init": "docsify init docs",
-    "docs:serve": "docsify serve docs",
-    "execute:example": "rimraf ./docs/types && node lib/cli/generate.js -s examples/force-app -t docs/types --scope global public private protected -g docsify --defaultGroupName \"Misc Group\" --namespace nspc --title \"Sample Documentation\" --documentationRootDir types",
-    "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly",
-    "execute:example:openapi": "node lib/cli/generate.js -s examples/force-app -t docs -g openapi --openApiTitle \"Sample REST Api\" --namespace nspc --openApiFileName restapi"
-  },
-  "author": "Cesar Parra",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/cesarParra/apexdocs"
-  },
-  "devDependencies": {
-    "@types/html-entities": "^1.3.4",
-    "@types/jest": "^27.4.1",
-    "@types/js-yaml": "^4.0.5",
-    "@types/node": "^13.7.4",
-    "@types/shelljs": "^0.8.6",
-    "@types/yargs": "^15.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.41.0",
-    "@typescript-eslint/parser": "^5.41.0",
-    "docsify": "^4.13.0",
-    "eslint": "^8.0.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^8.0.3",
-    "jest": "^27.5.1",
-    "lint-staged": "^13.2.1",
-    "prettier": "^2.4.1",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^27.1.3",
-    "typescript": "^4.8.4"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*.{js,ts,tsx}": [
-      "eslint --fix"
-    ]
-  },
-  "dependencies": {
-    "@cparra/apex-reflection": "2.8.0",
-    "chalk": "^4.1.2",
-    "cosmiconfig": "^9.0.0",
-    "fast-xml-parser": "^4.0.1",
-    "js-yaml": "^4.1.0",
-    "log-update": "4.0.0",
-    "xss": "^1.0.11",
-    "yargs": "^16.0.3"
-  }
-}
+{
+  "name": "@cparra/apexdocs",
+  "version": "2.25.0-alpha.1",
+  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
+  "keywords": [
+    "apex",
+    "salesforce",
+    "documentation",
+    "cli",
+    "apex-docs",
+    "docs"
+  ],
+  "main": "lib/index.js",
+  "bin": {
+    "apexdocs-generate": "lib/cli/generate.js"
+  },
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "build": "rimraf ./lib && npm run lint && tsc --declaration",
+    "lint": "eslint \"./src/**/*.{js,ts}\" --quiet --fix",
+    "prepare": "npm run build",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags",
+    "docs:init": "docsify init docs",
+    "docs:serve": "docsify serve docs",
+    "execute:example": "rimraf ./docs/types && node lib/cli/generate.js -s examples/force-app -t docs/types --scope global public private protected -g docsify --defaultGroupName \"Misc Group\" --namespace nspc --title \"Sample Documentation\" --documentationRootDir types",
+    "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly",
+    "execute:example:openapi": "node lib/cli/generate.js -s examples/force-app -t docs -g openapi --openApiTitle \"Sample REST Api\" --namespace nspc --openApiFileName restapi"
+  },
+  "author": "Cesar Parra",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cesarParra/apexdocs"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.6.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/html-entities": "^1.3.4",
+    "@types/jest": "^29.5.12",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.14.10",
+    "@types/shelljs": "^0.8.15",
+    "@types/yargs": "^17.0.32",
+    "docsify": "^4.13.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "husky": "^9.0.11",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.7",
+    "prettier": "^3.3.2",
+    "rimraf": "^6.0.0",
+    "ts-jest": "^29.2.0",
+    "typescript": "^5.5.3",
+    "typescript-eslint": "^7.16.0"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{js,ts,tsx}": [
+      "eslint --fix"
+    ]
+  },
+  "dependencies": {
+    "@cparra/apex-reflection": "2.9.3",
+    "chalk": "^5.3.0",
+    "cosmiconfig": "^9.0.0",
+    "fast-xml-parser": "^4.4.0",
+    "fp-ts": "^2.16.8",
+    "handlebars": "^4.7.8",
+    "js-yaml": "^4.1.0",
+    "log-update": "6.0.0",
+    "yargs": "^17.7.2"
+  }
+}

package/src/__spec__/core/expect-extensions.ts

@@ -0,0 +1,32 @@
+import * as E from 'fp-ts/Either';
+import { DocumentationBundle } from '../../core/generate-docs';
+
+export function extendExpect() {
+  expect.extend({
+    documentationBundleHasLength(received: E.Either<string[], DocumentationBundle>, length: number) {
+      return {
+        pass: E.isRight(received) && received.right.docs.length === length,
+        message: () => `Expected documentation bundle to have length ${length}`,
+      };
+    },
+    firstDocContains(doc: DocumentationBundle, content: string) {
+      return {
+        pass: doc.docs[0].docContents.includes(content),
+        message: () => `Expected documentation to contain ${content}. Got ${doc.docs[0].docContents}`,
+      };
+    },
+    firstDocContainsNot(doc: DocumentationBundle, content: string) {
+      return {
+        pass: !doc.docs[0].docContents.includes(content),
+        message: () => `Expected documentation to not contain ${content}. Got ${doc.docs[0].docContents}`,
+      };
+    },
+  });
+}
+
+export function assertEither<T, U>(result: E.Either<T, U>, assertion: (data: U) => void): void {
+  E.match<T, U, void>(
+    (error) => fail(error),
+    (data) => assertion(data),
+  )(result);
+}