@cparra/apexdocs 2.25.0-alpha.8 → 2.25.0

package/dist/defaults-DUwru49Q.js

@@ -1,12 +0,0 @@
-'use strict';
-
-const defaults = {
-  targetGenerator: "markdown",
-  targetDir: "./docs/",
-  scope: ["global"],
-  defaultGroupName: "Miscellaneous",
-  includeMetadata: false,
-  sortMembersAlphabetically: false
-};
-
-exports.defaults = defaults;

package/dist/defaults-SH0Rsi5E.js

@@ -1,11 +0,0 @@
-'use strict';
-
-const defaults = {
-  targetGenerator: "markdown",
-  targetDir: "./docs/",
-  scope: ["global"],
-  defaultGroupName: "Miscellaneous",
-  includeMetadata: false
-};
-
-exports.defaults = defaults;

package/dist/index.d.ts

@@ -1,62 +0,0 @@
-import { SetOptional } from 'type-fest';
-
-type ConfigurableHooks = {
-  transformReferenceGuide: TransformReferenceGuide;
-  transformDocs: TransformDocs;
-  transformDocPage: TransformDocPage;
-};
-
-type UserDefinedMarkdownConfig = {
-  targetGenerator: 'markdown';
-  sourceDir: string;
-  targetDir: string;
-  scope: string[];
-  defaultGroupName: string;
-  namespace?: string;
-  sortMembersAlphabetically: boolean;
-  includeMetadata: boolean;
-} & Partial<ConfigurableHooks>;
-
-type Frontmatter = string | Record<string, unknown> | null;
-
-type ReferenceGuidePageData = {
-  directory: string;
-  frontmatter: Frontmatter;
-  content: string;
-  fileExtension: string;
-  fileName: string;
-};
-
-type DocPageData = {
-  source: {
-    filePath: string;
-    name: string;
-    type: 'interface' | 'class' | 'enum';
-  };
-  group: string | null;
-  fileName: string;
-  fileExtension: string;
-  directory: string;
-  frontmatter: Frontmatter;
-  content: string;
-};
-
-type Skip = {
-  readonly _tag: 'Skip';
-};
-
-// Configurable Hooks
-
-type TransformReferenceGuide = (
-  referenceGuide: ReferenceGuidePageData,
-) => Partial<ReferenceGuidePageData> | Skip | Promise<Partial<ReferenceGuidePageData> | Skip>;
-
-type TransformDocs = (docs: DocPageData[]) => DocPageData[] | Promise<DocPageData[]>;
-
-type TransformDocPage = (doc: DocPageData) => Partial<DocPageData> | Promise<Partial<DocPageData>>;
-
-type ConfigurableMarkdownConfig = Omit<SetOptional<UserDefinedMarkdownConfig, 'targetDir' | 'scope' | 'defaultGroupName' | 'includeMetadata' | 'sortMembersAlphabetically'>, 'targetGenerator'>;
-declare function defineMarkdownConfig(config: ConfigurableMarkdownConfig): UserDefinedMarkdownConfig;
-declare function skip(): Skip;
-
-export { type ConfigurableHooks, type DocPageData, type ReferenceGuidePageData, defineMarkdownConfig, skip };

package/dist/index.js

@@ -1,36 +0,0 @@
-'use strict';
-
-var defaults = require('./defaults-DUwru49Q.js');
-
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-function defineMarkdownConfig(config) {
-  return __spreadProps(__spreadValues(__spreadValues({}, defaults.defaults), config), {
-    targetGenerator: "markdown"
-  });
-}
-function skip() {
-  return {
-    _tag: "Skip"
-  };
-}
-
-exports.defineMarkdownConfig = defineMarkdownConfig;
-exports.skip = skip;

package/eslint.config.mjs

@@ -1,10 +0,0 @@
-// @ts-check
-
-import eslint from '@eslint/js';
-import tseslint from 'typescript-eslint';
-import eslintConfigPrettier from "eslint-config-prettier";
-
-export default tseslint.config(
-  eslint.configs.recommended,
-  ...tseslint.configs.recommended,
-  eslintConfigPrettier);

package/examples/plain-markdown/.forceignore

@@ -1,12 +0,0 @@
-# List files or directories below to ignore them when running force:source:push, force:source:pull, and force:source:status
-# More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
-#
-
-package.xml
-
-# LWC configuration files
-**/jsconfig.json
-**/.eslintrc.json
-
-# LWC Jest
-**/__tests__/**

package/examples/plain-markdown/config/project-scratch-def.json

@@ -1,5 +0,0 @@
-{
-  "orgName": "cesarparra company",
-  "edition": "Developer",
-  "features": []
-}

package/examples/plain-markdown/docs/Miscellaneous/ns.BaseClass.md

@@ -1,16 +0,0 @@
-# BaseClass Class
-`abstract`
-
-## Namespace
-ns
-
-## Fields
-### `sampleEnumFromBase`
-
-#### Signature
-```apex
-public sampleEnumFromBase
-```
-
-#### Type
-[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)

package/examples/plain-markdown/docs/Miscellaneous/ns.MultiInheritanceClass.md

@@ -1,73 +0,0 @@
-# MultiInheritanceClass Class
-
-## Namespace
-ns
-
-**Inheritance**
-[ns.SampleClass](../SampleGroup/ns.SampleClass.md) < [ns.BaseClass](./ns.BaseClass.md)
-
-## Fields
-### `sampleEnumFromBase`
-
-*Inherited*
-
-#### Signature
-```apex
-public sampleEnumFromBase
-```
-
-#### Type
-[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
-
-## Properties
-### Group Name
-#### `someProperty`
-
-*Inherited*
-
-##### Signature
-```apex
-public someProperty
-```
-
-##### Type
-String
-
-## Methods
-### Available Methods
-#### `doSomething()`
-
-*Inherited*
-
-##### Signature
-```apex
-public void doSomething()
-```
-
-##### Return Type
-**void**
-
-### Deprecated Methods
-#### `sayHello()`
-
-*Inherited*
-
-`DEPRECATED`
-
-This is a sample method.
-
-##### Signature
-```apex
-public virtual String sayHello()
-```
-
-##### Return Type
-**String**
-
-A string value.
-
-##### Example
-```apex
-SampleClass sample = new SampleClass();
-sample.doSomething();
-```

package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md

@@ -1,15 +0,0 @@
-# ParentInterface Interface
-
-## Namespace
-ns
-
-## Methods
-### `sampleParentMethod()`
-
-#### Signature
-```apex
-public void sampleParentMethod()
-```
-
-#### Return Type
-**void**

package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md

@@ -1,8 +0,0 @@
-# ReferencedEnum Enum
-
-## Namespace
-ns
-
-## Values
-| Value | Description |
-|-------|-------------|

package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md

@@ -1,25 +0,0 @@
-# SampleException Class
-
-This is a sample exception.
-
-**Usage** 
-
-You can use the exception the following way. 
-
-You can also take a look at [ns.SampleClass](../SampleGroup/ns.SampleClass.md) to see how it is used. 
-
-This is a dangerous HTML tag: <script>alert('Hello');</script> 
-
-```apex
-try {
-   throw new SampleException();
-} catch (SampleException e) {
-  System.debug('Caught exception');
-}
-```
-
-## Namespace
-ns
-
-**Inheritance**
-Exception

package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md

@@ -1,119 +0,0 @@
-# SampleInterface Interface
-
-`NAMESPACEACCESSIBLE`
-
-This is a sample interface
-
-**Author** John Doe
-
-**Date** 2020-01-01
-
-**See** [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
-
-**See** [ns.ReferencedEnum](./ns.ReferencedEnum.md)
-
-## Namespace
-ns
-
-## Diagram
-```mermaid
-graph TD
-   A[SampleInterface] -->|extends| B[ParentInterface]
-   B -->|extends| C[GrandParentInterface]
-   C -->|extends| D[GreatGrandParentInterface]
-```
-
-## Example
-```apex
-SampleInterface sampleInterface = new SampleInterface();
-sampleInterface.sampleMethod();
-```
-
-**Extends**
-[ns.ParentInterface](./ns.ParentInterface.md)
-
-## Methods
-### `sampleMethod()`
-
-`NAMESPACEACCESSIBLE`
-
-This is a sample method
-
-**Custom Tag** 
-
-This is a custom tag
-
-**Another Custom Tag** 
-
-This is another custom tag
-
-#### Signature
-```apex
-public String sampleMethod()
-```
-
-#### Return Type
-**String**
-
-Some return value
-
-#### Throws
-[ns.SampleException](./ns.SampleException.md): This is a sample exception
-
-AnotherSampleException: This is another sample exception
-
-#### Diagram
-```mermaid
-graph TD
-  A[SampleInterface] -->|extends| B[ParentInterface]
-  B -->|extends| C[GrandParentInterface]
-  C -->|extends| D[GreatGrandParentInterface]
-```
-
-#### Example
-```apex
-SampleInterface sampleInterface = new SampleInterface();
-sampleInterface.sampleMethod();
-```
-
----
-
-### `sampleMethodWithParams(param1, param2, theEnum)`
-
-`NAMESPACEACCESSIBLE`
-`DEPRECATED`
-
-This is a sample method with parameters 
-
-Sometimes it won't be possible to find a NonExistent link.
-
-#### Signature
-```apex
-public SampleEnum sampleMethodWithParams(String param1, Integer param2, SampleEnum theEnum)
-```
-
-#### Parameters
-| Name | Type | Description |
-|------|------|-------------|
-| param1 | String | This is the first parameter |
-| param2 | Integer | This is the second parameter |
-| theEnum | [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md) | This is an enum parameter |
-
-#### Return Type
-**[ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)**
-
-Some return value
-
----
-
-### `sampleParentMethod()`
-
-*Inherited*
-
-#### Signature
-```apex
-public void sampleParentMethod()
-```
-
-#### Return Type
-**void**