@cparra/apexdocs 3.7.3 → 3.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -309,6 +309,15 @@ export default defineMarkdownConfig({
309
309
  });
310
310
  ```
311
311
 
312
+ You can also leverage the `exclude` property to indirectly modify things like custom metadata records you do
313
+ not want included in the custom metadata type object documentation.
314
+
315
+ ```typescript
316
+ //...
317
+ exclude: ['**/*.md-meta.xml']
318
+ //...
319
+ ```
320
+
312
321
  ### Excluding Tags from Appearing in the Documentation
313
322
 
314
323
  Note: Only works for Markdown documentation.
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env node
2
2
  'use strict';
3
3
 
4
- var logger$1 = require('../logger-B7R1BwqQ.js');
4
+ var logger$1 = require('../logger-B0wNVQij.js');
5
5
  var module$1 = require('module');
6
6
  var cosmiconfig = require('cosmiconfig');
7
7
  var E = require('fp-ts/Either');
package/dist/index.d.ts CHANGED
@@ -25,7 +25,7 @@ type CliConfigurableMarkdownConfig = {
25
25
  };
26
26
 
27
27
  type UserDefinedMarkdownConfig = {
28
- targetGenerator: 'markdown' /** Glob patterns to exclude files from the documentation. */;
28
+ targetGenerator: 'markdown';
29
29
  excludeTags: string[];
30
30
  exclude: string[];
31
31
  } & CliConfigurableMarkdownConfig &
@@ -55,7 +55,7 @@ type UserDefinedChangelogConfig = {
55
55
 
56
56
  type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig | UserDefinedChangelogConfig;
57
57
 
58
- type MetadataTypes = 'interface' | 'class' | 'enum' | 'customobject' | 'customfield';
58
+ type MetadataTypes = 'interface' | 'class' | 'enum' | 'customobject' | 'customfield' | 'custommetadata';
59
59
 
60
60
  type SourceFileMetadata = {
61
61
  filePath: string;
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  'use strict';
2
2
 
3
- var logger = require('./logger-B7R1BwqQ.js');
3
+ var logger = require('./logger-B0wNVQij.js');
4
4
  var E = require('fp-ts/Either');
5
5
  require('fp-ts/function');
6
6
  require('fp-ts/TaskEither');