@cparra/apexdocs 3.0.0 → 3.1.0

package/README.md

@@ -74,9 +74,11 @@ Here are some live projects using ApexDocs:
 
 ## ▶️ Available Commands
 
+### Markdown
+
 `markdown`
 
-### Flags
+#### Flags
 
 | Flag                   | Alias | Description                                                                                                                                                                                              | Default         | Required |
 |------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|----------|
@@ -89,7 +91,7 @@ Here are some live projects using ApexDocs:
 | `--includeMetadata `   | N/A   | Whether to include the file's meta.xml information: Whether it is active and and the API version                                                                                                         | `false`         | No       |
 | `--linkingStrategy`    | N/A   | The strategy to use when linking to other classes. Possible values are `relative`, `no-link`, and `none`                                                                                                 | `relative`      | No       |
 
-#### Linking Strategy
+##### Linking Strategy
 
 The linking strategy determines how ApexDocs will link to other classes in your documentation. For example,
 if I have class `A` that links through class `B` (e.g. through an `{@link B}` tag, the `@see` tag,
@@ -115,15 +117,19 @@ Does not apply any kind of logic. Instead, the links will be determined by the p
 from the root of the documentation site OR by whatever path you have returned in the `transformReference` hook
 for the file.
 
-### Sample Usage
+#### Sample Usage
 
 ```bash
 apexdocs markdown -s force-app -t docs -p global public namespaceaccessible -n MyNamespace
 ```
 
+---
+
+### OpenApi
+
 `openapi`
 
-### Flags
+#### Flags
 
 | Flag           | Alias | Description                                                                   | Default         | Required |
 |----------------|-------|-------------------------------------------------------------------------------|-----------------|----------|
@@ -134,7 +140,7 @@ apexdocs markdown -s force-app -t docs -p global public namespaceaccessible -n M
 | `--title`      | N/A   | The title of the OpenApi file.                                                | `Apex REST API` | No       |
 | `--apiVersion` | N/A   | The version of the API.                                                       | `1.0.0`         | No       |
 
-### Sample Usage
+#### Sample Usage
 
 ```bash
 apexdocs openapi -s force-app -t docs -n MyNamespace --title "My Custom OpenApi Title"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -12,6 +12,9 @@
   ],
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "bin": {
     "apexdocs": "./dist/cli/generate.js"
   },

package/.github/workflows/ci.yaml

@@ -1,22 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: ["master", "develop"]
-  pull_request:
-    branches: ["main", "develop"]
-  workflow_dispatch:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup node
-        uses: actions/setup-node@v3
-        with:
-          node-version: "20"
-          cache: "npm"
-      - run: npm ci
-      - run: npm run build --if-present
-      - run: npm test

package/.github/workflows/close_stale.yml

@@ -1,22 +0,0 @@
-name: Close inactive issues
-on:
-  schedule:
-    - cron: "30 1 * * *"
-
-jobs:
-  close-issues:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-    steps:
-      - uses: actions/stale@v5
-        with:
-          days-before-issue-stale: 30
-          days-before-issue-close: 14
-          stale-issue-label: "stale"
-          stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
-          close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
-          days-before-pr-stale: -1
-          days-before-pr-close: -1
-          repo-token: ${{ secrets.GITHUB_TOKEN }}

package/.prettierrc.js

@@ -1,7 +0,0 @@
-module.exports = {
-  semi: true,
-  trailingComma: 'all',
-  singleQuote: true,
-  printWidth: 120,
-  tabWidth: 2,
-};

package/__mocks__/chalk.js

@@ -1,12 +0,0 @@
-// __mocks__/chalk.js
-module.exports = new Proxy(
-  {},
-  {
-    get: function (target, property) {
-      return property === 'default' ? this : (text) => text;
-    },
-    green: function (text) {
-      return text;
-    },
-  },
-);

package/__mocks__/log-update.js

@@ -1,6 +0,0 @@
-// This is a basic mock that can be expanded based on your needs.
-// It mocks the main function of log-update to just log to console or do nothing.
-module.exports = {
-  // Mock the main function to just log the text or do nothing
-  default: function () {},
-};

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/README.md

@@ -1,5 +0,0 @@
-# Examples
-
-This folder contains a few examples of how to use ApexDocs for different use cases, and with different tools.
-
-Go into each example folder to get an overview of how it works, and how you can configure it for your own project.

package/examples/docsify/README.md

@@ -1,17 +0,0 @@
-# Docsify Example
-
-This project contains an example on how to generate documentation to be rendered with [Docsify](https://docsify.js.org).
-
-## Getting Started
-
-* Follow the Docsify getting started instructions [here](https://docsify.js.org/#/quickstart).
-
-## Configuration
-
-Take a look at the `apexdocs.config.ts` file to see how the configuration is set up.
-
-Pay special attention to the following:
-
-* `linkingStrategy` -> This must be set to "none" for Docsify to correctly render the links.
-
-* `transformReferenceGuide` -> Overrides the name of the `index` file to `README` so that Docsify can correctly render the home page.

package/examples/docsify/apexdocs.config.ts

@@ -1,13 +0,0 @@
-import { defineMarkdownConfig } from '../../src';
-
-export default defineMarkdownConfig({
-  sourceDir: 'classes',
-  targetDir: 'docs',
-  scope: ['public', 'global'],
-  linkingStrategy: 'none',
-  transformReferenceGuide: () => {
-    return {
-      outputDocPath: 'README.md',
-    };
-  },
-});

package/examples/docsify/classes/ASampleClass.cls

@@ -1,57 +0,0 @@
-/**
- * @description This is a class description.
- * @see SomeDto
- * @see SampleInterface
- * @mermaid
- * ```mermaid
-  * sequenceDiagram
-  *     participant dotcom
-  *     participant iframe
-  *     participant viewscreen
-  *     dotcom->>iframe: loads html w/ iframe url
-  *     iframe->>viewscreen: request template
-  *     viewscreen->>iframe: html & javascript
-  *     iframe->>dotcom: iframe ready
-  *     dotcom->>iframe: set mermaid data on iframe
-  *     iframe->>iframe: render mermaid
-  * ```
- */
-public class ASampleClass {
-    /**
-     * @description Some description
-     * @param surveyType2 my value
-     * @return whatever
-     */
-    public static Map<String, Object> getActiveSurveySettings(String surveyType2) {
-        System.debug('Map based example');
-    }
-
-    public static List< String > someMethod() {
-        System.debug('Some method.');
-    }
-
-    /**
-     * @description Executes commands based on the passed in argument.
-     */
-    public static String sampleMethod(List<String> argument) {
-        System.debug('Execute');
-        return '';
-    }
-
-    /**
-     * @description Calls the method.
-     * This methods allows you to call it.
-     */
-    public static void call() {
-    }
-
-//    /**
-//     * @description This is a String property.
-//     */
-//    String MyProp { get; set; }
-//
-//    /**
-//     * @description This is a Decimal property.
-//     */
-//    Decimal AnotherProp { get; private set; }
-}

package/examples/docsify/classes/CodeControl.cls

@@ -1,19 +0,0 @@
-public with sharing class CodeControl {
-
-    // @start-group Picklist constant for Code_Control__mdt.Logging__c
-    public static final String LOGGING_CONTROL_NONE = 'None';
-    public static final String LOGGING_CONTROL_DEBUG = 'Debug';
-    public static final String LOGGING_CONTROL_ERROR = 'Error';
-    // @end-group
-
-    // @start-group Picklist constants for Code_Control__mdt.Enabled__c
-    public static final String TRIGGER_CONTROL_ENABLED = 'Yes';
-    public static final String TRIGGER_CONTROL_DISABLED = 'No';
-    public static final String FEATURE_CONTROL_ENABLED = 'Yes';
-    public static final String FEATURE_CONTROL_DISABLED = 'No';
-    // @end-group
-
-    /* Special MDT values */
-    public static final String WILDCARD_SOURCE = 'CodeControl_Default';
-    public static final String SYSTEM_WIDE_SOURCE = 'CodeControl_Override';
-}

package/examples/docsify/classes/SampleClass.cls

@@ -1,95 +0,0 @@
-/**
- * @description This is a class description.
- * @group Sample Classes
- * @see SampleInterface
- */
-@NamespaceAccessible
-public with sharing class SampleClass {
-    /**
-     * @description Constructs a SampleClass without any arguments.
-     * @example
-     * ```apex
-     * SampleClass sampleInstance = new SampleClass();
-     * ```
-     */
-    @NamespaceAccessible
-    public SampleClass() {
-        System.debug('Constructor');
-    }
-
-    /**
-     * @description Constructs a SampleClass with an argument.
-     * @param argument Some argument
-     */
-    public SampleClass(String argument) {
-        System.debug('Constructor');
-    }
-
-    /**
-     * @description Executes commands based on the passed in argument.
-     * @example
-     * ```apex
-     * String result = SampleClass.testMethod();
-     * System.debug(result);
-     * ```
-     */
-    @NamespaceAccessible
-    public static String someTestMethod(String argument) {
-        System.debug('Execute');
-        return '';
-    }
-
-
-    /**
-     * @description Calls the method.
-     * This methods allows you to call it.
-     */
-    public static void call() {
-    }
-
-    /**
-     * @description This is a String property.
-     */
-    public String MyProp { get; set; }
-
-    /**
-     * @description This is a Decimal property.
-     */
-    public Decimal AnotherProp { get; private set; }
-
-    /**
-     * @description Inner class belonging to SampleClass.
-     */
-    public class InnerClass {
-        /**
-         * @description Description of the inner property.
-         */
-        public String InnerProp {get; set;}
-
-        /**
-         * @description Executes from the inner class.
-         */
-        public void innerMethod() {
-            System.debug('Executing inner method.');
-        }
-    }
-
-    /**
-     * @description Inner class belonging to SampleClass.
-     */
-    public class AnotherInnerClass {
-        /**
-         * @description Description of the inner property.
-         */
-        public String InnerProp {
-            get; set;
-        }
-
-        /**
-         * @description Executes from the inner class.
-         */
-        public void innerMethod() {
-            System.debug('Executing inner method.');
-        }
-    }
-}

package/examples/docsify/classes/SampleInterface.cls

@@ -1,17 +0,0 @@
-/**
- * @description This is an interface description.
- * @group Sample Interfaces
- * @see SampleClass
- */
-public interface SampleInterface {
-    /**
-     * @description Executes the command.
-     */
-    void execute();
-
-    /**
-     * @description Returns a value based on the executed command.
-     * @return Empty value
-     */
-    String getValue();
-}

package/examples/docsify/classes/SomeDto.cls

@@ -1,122 +0,0 @@
-/**
- * @description Some description
- * @see ASampleClass
- */
-public with sharing class SomeDto {
-    /**
-     * @description Used in cartItem.html
-     */
-    public class CartItemDto {
-        public CartItemDto(String id, String description, Decimal quantity, Decimal price, String currencyCode, String productImage, Boolean isDiscounted, Decimal adjustedAmount, String discountReason) {
-            this.Id = id;
-            this.Description = description;
-            this.Quantity = quantity;
-            this.Price = price.setScale(2);
-            this.CurrencyCode = currencyCode;
-            this.ProductImage = productImage;
-            this.IsDiscounted = isDiscounted;
-            this.AdjustedPrice = adjustedAmount.setScale(2);
-            this.DiscountReason = discountReason;
-        }
-
-        /**
-         * @description Id Unique identifier for this object.
-         */
-        @AuraEnabled
-        public String Id { get; set; }
-
-        /**
-         * @description Description The description to display for this item.
-         */
-        @AuraEnabled
-        public String Description { get; set; }
-
-        /**
-         * @description Quantity Amount of this item currently in the cart.
-         */
-        @AuraEnabled
-        public Decimal Quantity { get; set; }
-
-        /**
-         * @description Price Calculated price for this item.
-         */
-        @AuraEnabled
-        public Decimal Price { get; set; }
-
-        /**
-         * @description The currency code for this item.
-         */
-        @AuraEnabled
-        public String CurrencyCode { get; set; }
-
-        /**
-         * @description ProductImage Main display image to display for this item.
-         */
-        @AuraEnabled
-        public String ProductImage { get; set; }
-
-        /**
-         * @description IsDiscounted Whether the item has been discounted or not.
-         */
-        @AuraEnabled
-        public Boolean IsDiscounted { get; set; }
-
-        /**
-         * @description AdjustedPrice If the item has been discounted, this contains the adjusted (lower) price.
-         */
-        @AuraEnabled
-        public Decimal AdjustedPrice { get; set; }
-
-        /**
-         * @description DiscountReason If the item has been discounted, this contains a human-readable reason for the discount.
-         */
-        @AuraEnabled
-        public String DiscountReason { get; set; }
-    }
-
-    @AuraEnabled
-    public List<CartItemDto> Items { get; set; }
-
-    @AuraEnabled
-    public Decimal SubTotal { get; set; }
-
-    @AuraEnabled
-    public Decimal Total { get; set; }
-
-    @AuraEnabled
-    public Decimal Discounts { get; set; }
-
-    /**
-     * @description Constructs a CartDto
-     * @param proForma The pro forma
-     */
-    public CartDto(nams.Order proForma) {
-        this.Items = new List<CartDto.CartItemDto>();
-        this.SubTotal = proForma.getSubTotal().getValue().setScale(2);
-        this.Total = proForma.getGrandTotal().getValue().setScale(2);
-        this.Discounts = proForma.getTotalDiscounts().getValue().setScale(2);
-
-        for (OrderLine line : proForma.getLines()) {
-            String imageUrl;
-            if (!line.getProduct().getImages().isEmpty()) {
-                imageUrl = line.getProduct().getImages()[0].getImageUrl();
-            }
-            Boolean isDiscounted = line.getTotalDiscounts() != Money.zero();
-            String discountReason;
-            if (isDiscounted) {
-                discountReason = line.getAdjustments()[0].getDescription();
-            }
-            this.Items.add(new CartItemDto(
-                line.getId(),
-                line.getProduct().getName(),
-                line.getQuantity(),
-                line.getSubTotal().getValue(),
-                line.getUnitPrice().getCurrency(),
-                imageUrl,
-                isDiscounted,
-                line.getGrandTotal().getValue(),
-                discountReason
-            ));
-        }
-    }
-}

package/examples/docsify/docs/README.md

@@ -1,25 +0,0 @@
-# Apex Reference Guide
-
-## Miscellaneous
-
-### [ASampleClass](miscellaneous/ASampleClass.md)
-
-This is a class description.
-
-### [CodeControl](miscellaneous/CodeControl.md)
-
-### [SomeDto](miscellaneous/SomeDto.md)
-
-Some description
-
-## Sample Classes
-
-### [SampleClass](sample-classes/SampleClass.md)
-
-This is a class description.
-
-## Sample Interfaces
-
-### [SampleInterface](sample-interfaces/SampleInterface.md)
-
-This is an interface description.

package/examples/docsify/docs/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-cayman

package/examples/docsify/docs/index.html

@@ -1,22 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <title>Document</title>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-  <meta name="description" content="Description">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
-  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
-</head>
-<body>
-  <div id="app"></div>
-  <script>
-    window.$docsify = {
-      name: '',
-      repo: ''
-    }
-  </script>
-  <!-- Docsify v4 -->
-  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
-</body>
-</html>

package/examples/docsify/docs/miscellaneous/ASampleClass.md

@@ -1,88 +0,0 @@
-# ASampleClass Class
-
-This is a class description.
-
-**Mermaid** 
-
-```mermaid
-sequenceDiagram
-    participant dotcom
-    participant iframe
-    participant viewscreen
-    dotcom->>iframe: loads html w/ iframe url
-    iframe->>viewscreen: request template
-    viewscreen->>iframe: html & javascript
-    iframe->>dotcom: iframe ready
-    dotcom->>iframe: set mermaid data on iframe
-    iframe->>iframe: render mermaid
-```
-
-**See** [SomeDto](miscellaneous/SomeDto.md)
-
-**See** [SampleInterface](sample-interfaces/SampleInterface.md)
-
-## Methods
-### `getActiveSurveySettings(surveyType2)`
-
-Some description
-
-#### Signature
-```apex
-public static Map<String,Object> getActiveSurveySettings(String surveyType2)
-```
-
-#### Parameters
-| Name | Type | Description |
-|------|------|-------------|
-| surveyType2 | String | my value |
-
-#### Return Type
-**Map&lt;String,Object&gt;**
-
-whatever
-
----
-
-### `someMethod()`
-
-#### Signature
-```apex
-public static List<String> someMethod()
-```
-
-#### Return Type
-**List&lt;String&gt;**
-
----
-
-### `sampleMethod(argument)`
-
-Executes commands based on the passed in argument.
-
-#### Signature
-```apex
-public static String sampleMethod(List<String> argument)
-```
-
-#### Parameters
-| Name | Type | Description |
-|------|------|-------------|
-| argument | List&lt;String&gt; |  |
-
-#### Return Type
-**String**
-
----
-
-### `call()`
-
-Calls the method. 
-This methods allows you to call it.
-
-#### Signature
-```apex
-public static void call()
-```
-
-#### Return Type
-**void**