@docfy/ember 0.8.4 → 0.9.0

package/addon/components/docfy-demo/example.hbs

@@ -1,3 +1,3 @@
-<div class="docfy-demo__example" ...attributes>
+<div class="docfy-demo__example not-prose" ...attributes>
   {{yield}}
-</div>
+</div>

package/addon/components/docfy-demo.hbs

@@ -1,4 +1,4 @@
-<div id={{@id}} class="docfy-demo not-prose" ...attributes>
+<div id={{@id}} class="docfy-demo" ...attributes>
   {{yield
     (hash
       Example=(component "docfy-demo/example")

package/dummy-docs/packages/ember/components/docfy-with-hyphenated-number-2-demo/demo1.md

@@ -0,0 +1,25 @@
+---
+order: 1
+---
+
+# Demo of DocfyLink component
+
+[Link from a demo](../docfy-output.md)
+
+```hbs template
+<div data-test-id="demo-1">
+  This is my Demo:
+
+  <span class='hyphenated-demo'>Assertable DOM node</span>
+  <DocfyLink @to={{this.url}}>My Link</DocfyLink>
+</div>
+<div data-test-id="demo-1-js-data">{{this.url}}</div>
+```
+
+```js component
+import Component from '@glimmer/component';
+
+export default class MyDemo extends Component {
+  url = '/docs/ember/';
+}
+```

package/dummy-docs/packages/ember/components/docfy-with-hyphenated-number-2.md

@@ -0,0 +1,9 @@
+---
+category: ember
+subcategory: components
+---
+
+# Docfy With Hyphenated Number 2
+
+Testing doc pages with numbers in their name and how that corresponds with
+automatic component registration.

package/lib/get-config.d.ts

@@ -3,5 +3,5 @@ import type { RemarkHbsOptions } from 'remark-hbs';
 interface EmberDocfyConfig extends DocfyConfig {
     remarkHbsOptions?: RemarkHbsOptions;
 }
-export default function getDocfyConfig(root: string): EmberDocfyConfig;
+export default function getDocfyConfig(root: string): Promise<EmberDocfyConfig>;
 export {};

package/lib/get-config.js

@@ -1,9 +1,38 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
+const url_1 = require("url");
 const remark_hbs_1 = __importDefault(require("remark-hbs"));
 const replace_internal_links_with_docfy_link_1 = __importDefault(require("./plugins/replace-internal-links-with-docfy-link"));
 const extract_demos_to_components_1 = __importDefault(require("./plugins/extract-demos-to-components"));
@@ -17,53 +46,73 @@ const DEFAULT_CONFIG = {
     ]
 };
 function getDocfyConfig(root) {
-    const configPath = path_1.default.join(root, '.docfy-config.js');
-    let docfyConfig = DEFAULT_CONFIG;
-    const pkg = require(path_1.default.join(root, 'package.json')); // eslint-disable-line
-    try {
-        docfyConfig = require(configPath); // eslint-disable-line @typescript-eslint/no-require-imports
-    }
-    catch (e) {
-        if (!e.message.match(new RegExp(`Cannot find module .${configPath}`))) {
-            throw e;
+    var _a, _b, _c, _d, _e;
+    return __awaiter(this, void 0, void 0, function* () {
+        const configPath = path_1.default.join(root, '.docfy-config.js');
+        let docfyConfig = {};
+        // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
+        const pkg = require(path_1.default.join(root, 'package.json'));
+        try {
+            // Attempt to require (CJS)
+            // eslint-disable-next-line @typescript-eslint/no-require-imports
+            docfyConfig = require(configPath);
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }
-    }
-    if (typeof docfyConfig === 'object') {
-        if (typeof docfyConfig.sources === 'undefined') {
-            docfyConfig.sources = DEFAULT_CONFIG.sources;
+        catch (e) {
+            // Fallback to ESM if the error indicates ESM-only module
+            const isESMError = e.code === 'ERR_REQUIRE_ESM' ||
+                ((_a = e.message) === null || _a === void 0 ? void 0 : _a.includes('must use import to load ES Module')) ||
+                ((_b = e.message) === null || _b === void 0 ? void 0 : _b.includes('Cannot use import statement outside a module'));
+            if (isESMError || e.code === 'ERR_MODULE_NOT_FOUND') {
+                try {
+                    const imported = yield Promise.resolve().then(() => __importStar(require((0, url_1.pathToFileURL)(configPath).href)));
+                    docfyConfig = (_c = imported === null || imported === void 0 ? void 0 : imported.default) !== null && _c !== void 0 ? _c : imported;
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                }
+                catch (esmErr) {
+                    const notFound = esmErr.code === 'ERR_MODULE_NOT_FOUND' ||
+                        ((_d = esmErr.message) === null || _d === void 0 ? void 0 : _d.includes('Cannot find module'));
+                    if (!notFound) {
+                        throw esmErr;
+                    }
+                    docfyConfig = {};
+                }
+            }
+            else {
+                throw e;
+            }
+        }
+        if (typeof docfyConfig !== 'object' || docfyConfig == null) {
+            docfyConfig = {};
         }
         if (!Array.isArray(docfyConfig.sources)) {
-            console.warn('Docfy expected an array for sources in .docfy-config.js, received ', typeof docfyConfig.sources);
             docfyConfig.sources = DEFAULT_CONFIG.sources;
         }
-    }
-    else {
-        docfyConfig = DEFAULT_CONFIG;
-    }
-    const repoUrl = pkg.repository.url || pkg.repository;
-    if (!docfyConfig.repository &&
-        typeof repoUrl === 'string' &&
-        repoUrl !== '') {
-        docfyConfig.repository = {
-            url: repoUrl
-        };
-    }
-    if (!Array.isArray(docfyConfig.plugins)) {
-        docfyConfig.plugins = [];
-    }
-    docfyConfig.plugins.unshift(replace_internal_links_with_docfy_link_1.default, preview_template_1.default, extract_demos_to_components_1.default);
-    if (!Array.isArray(docfyConfig.remarkPlugins)) {
-        docfyConfig.remarkPlugins = [];
-    }
-    docfyConfig.remarkPlugins.push([
-        remark_hbs_1.default,
-        docfyConfig.remarkHbsOptions || {}
-    ]);
-    docfyConfig.sources.forEach((source) => {
-        if (typeof source.root === 'undefined') {
-            source.root = path_1.default.join(root, 'docs');
+        if (!Array.isArray(docfyConfig.plugins)) {
+            docfyConfig.plugins = [];
+        }
+        docfyConfig.plugins.unshift(replace_internal_links_with_docfy_link_1.default, preview_template_1.default, extract_demos_to_components_1.default);
+        if (!Array.isArray(docfyConfig.remarkPlugins)) {
+            docfyConfig.remarkPlugins = [];
+        }
+        docfyConfig.remarkPlugins.push([
+            remark_hbs_1.default,
+            docfyConfig.remarkHbsOptions || {}
+        ]);
+        const repoUrl = ((_e = pkg.repository) === null || _e === void 0 ? void 0 : _e.url) || pkg.repository;
+        if (!docfyConfig.repository &&
+            typeof repoUrl === 'string' &&
+            repoUrl !== '') {
+            docfyConfig.repository = {
+                url: repoUrl
+            };
         }
+        docfyConfig.sources.forEach((source) => {
+            if (typeof source.root === 'undefined') {
+                source.root = path_1.default.join(root, 'docs');
+            }
+        });
+        return docfyConfig;
     });
-    return docfyConfig;
 }
 exports.default = getDocfyConfig;

package/lib/plugins/utils.js

@@ -112,6 +112,9 @@ function generateDemoComponentName(identifier, seenNames, tentativeCount = 1) {
     const pascalCase = dashCase
         .replace(/(\w)(\w*)/g, function (_, g1, g2) {
         return `${g1.toUpperCase()}${g2.toLowerCase()}`;
+    })
+        .replace(/-(\d+)/g, function (_, g1) {
+        return `_${g1}`;
     })
         .replace(/-/g, '');
     if (seenNames.has(dashCase)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docfy/ember",
-  "version": "0.8.4",
+  "version": "0.9.0",
   "description": "Ember integration with Docfy",
   "keywords": [
     "ember-addon",
@@ -30,7 +30,7 @@
     "test:ember-compatibility": "echo 'ember try:each TODO'"
   },
   "dependencies": {
-    "@docfy/core": "^0.8.0",
+    "@docfy/core": "^0.9.0",
     "broccoli-bridge": "^1.0.0",
     "broccoli-file-creator": "^2.1.1",
     "broccoli-funnel": "^3.0.8",
@@ -52,7 +52,7 @@
   },
   "devDependencies": {
     "@babel/helper-define-map": "^7.16.7",
-    "@docfy/plugin-with-prose": "^0.8.4",
+    "@docfy/plugin-with-prose": "^0.9.0",
     "@ember/optional-features": "^2.0.0",
     "@ember/test-helpers": "^2.6.0",
     "@embroider/compat": "^1.0.0",
@@ -137,5 +137,5 @@
       "prember"
     ]
   },
-  "gitHead": "23974b3e2ef51086b60a18beec137628f6e6b12d"
+  "gitHead": "7084e3983d67d3d0d704a2aa13cd31341e6aaa4f"
 }

package/src/get-config.ts

@@ -1,4 +1,5 @@
 import path from 'path';
+import { pathToFileURL } from 'url';
 import { DocfyConfig } from '@docfy/core/lib/types';
 import remarkHbs from 'remark-hbs';
 import replaceInternalLinksWithDocfyLink from './plugins/replace-internal-links-with-docfy-link';
@@ -19,52 +20,58 @@ interface EmberDocfyConfig extends DocfyConfig {
   remarkHbsOptions?: RemarkHbsOptions;
 }
 
-export default function getDocfyConfig(root: string): EmberDocfyConfig {
+export default async function getDocfyConfig(
+  root: string
+): Promise<EmberDocfyConfig> {
   const configPath = path.join(root, '.docfy-config.js');
-  let docfyConfig: EmberDocfyConfig = DEFAULT_CONFIG;
+  let docfyConfig: Partial<EmberDocfyConfig> = {};
 
-  const pkg = require(path.join(root, 'package.json')); // eslint-disable-line
+  // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
+  const pkg = require(path.join(root, 'package.json'));
 
   try {
-    docfyConfig = require(configPath); // eslint-disable-line @typescript-eslint/no-require-imports
-  } catch (e) {
-    if (!e.message.match(new RegExp(`Cannot find module .${configPath}`))) {
+    // Attempt to require (CJS)
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    docfyConfig = require(configPath);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  } catch (e: any) {
+    // Fallback to ESM if the error indicates ESM-only module
+    const isESMError =
+      e.code === 'ERR_REQUIRE_ESM' ||
+      e.message?.includes('must use import to load ES Module') ||
+      e.message?.includes('Cannot use import statement outside a module');
+
+    if (isESMError || e.code === 'ERR_MODULE_NOT_FOUND') {
+      try {
+        const imported = await import(pathToFileURL(configPath).href);
+        docfyConfig = imported?.default ?? imported;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      } catch (esmErr: any) {
+        const notFound =
+          esmErr.code === 'ERR_MODULE_NOT_FOUND' ||
+          esmErr.message?.includes('Cannot find module');
+        if (!notFound) {
+          throw esmErr;
+        }
+        docfyConfig = {};
+      }
+    } else {
       throw e;
     }
   }
 
-  if (typeof docfyConfig === 'object') {
-    if (typeof docfyConfig.sources === 'undefined') {
-      docfyConfig.sources = DEFAULT_CONFIG.sources;
-    }
-
-    if (!Array.isArray(docfyConfig.sources)) {
-      console.warn(
-        'Docfy expected an array for sources in .docfy-config.js, received ',
-        typeof docfyConfig.sources
-      );
-
-      docfyConfig.sources = DEFAULT_CONFIG.sources;
-    }
-  } else {
-    docfyConfig = DEFAULT_CONFIG;
+  if (typeof docfyConfig !== 'object' || docfyConfig == null) {
+    docfyConfig = {};
   }
 
-  const repoUrl = pkg.repository.url || pkg.repository;
-
-  if (
-    !docfyConfig.repository &&
-    typeof repoUrl === 'string' &&
-    repoUrl !== ''
-  ) {
-    docfyConfig.repository = {
-      url: repoUrl
-    };
+  if (!Array.isArray(docfyConfig.sources)) {
+    docfyConfig.sources = DEFAULT_CONFIG.sources;
   }
 
   if (!Array.isArray(docfyConfig.plugins)) {
     docfyConfig.plugins = [];
   }
+
   docfyConfig.plugins.unshift(
     replaceInternalLinksWithDocfyLink,
     previewTemplate,
@@ -80,11 +87,23 @@ export default function getDocfyConfig(root: string): EmberDocfyConfig {
     docfyConfig.remarkHbsOptions || {}
   ]);
 
+  const repoUrl = pkg.repository?.url || pkg.repository;
+
+  if (
+    !docfyConfig.repository &&
+    typeof repoUrl === 'string' &&
+    repoUrl !== ''
+  ) {
+    docfyConfig.repository = {
+      url: repoUrl
+    };
+  }
+
   docfyConfig.sources.forEach((source) => {
     if (typeof source.root === 'undefined') {
       source.root = path.join(root, 'docs');
     }
   });
 
-  return docfyConfig;
+  return docfyConfig as EmberDocfyConfig;
 }

package/src/plugins/utils.ts

@@ -153,6 +153,9 @@ export function generateDemoComponentName(
     .replace(/(\w)(\w*)/g, function (_, g1, g2) {
       return `${g1.toUpperCase()}${g2.toLowerCase()}`;
     })
+    .replace(/-(\d+)/g, function (_, g1) {
+      return `_${g1}`;
+    })
     .replace(/-/g, '');
 
   if (seenNames.has(dashCase)) {