@docfy/ember 0.12.0 → 0.13.0

package/declarations/components/docfy-link.d.ts

@@ -12,9 +12,28 @@ interface DocfyLinkSignature {
         default: [];
     };
 }
+/**
+ * A link to a Docfy page.
+ *
+ * Docfy addresses pages by URL, and `@to` is already the router's path, so
+ * neither the href nor the active state needs the target route resolved.
+ *
+ * That matters under Embroider's `splitAtRoutes`: `RouterService#recognize()`
+ * resolves the matched route handlers, and resolving a route inside a split
+ * bundle makes `@embroider/router` fetch that bundle. Calling it from a getter
+ * meant that merely rendering a link downloaded the page it pointed at, so a
+ * page linking to every section pulled the whole documentation site up front.
+ * Recognition now happens in `navigate`, where the bundle is about to be needed
+ * anyway.
+ */
 export default class DocfyLink extends Component<DocfyLinkSignature> {
     router: RouterService;
-    get routeName(): string | undefined;
+    /**
+     * `@to` as the router would produce it. Docfy gives index pages a trailing
+     * slash (`/docs/getting-started/`) where `urlFor` did not, so it is dropped
+     * here to keep the rendered href unchanged.
+     */
+    get path(): string;
     get href(): string;
     get isActive(): boolean;
     navigate(event: MouseEvent): void;

package/declarations/components/docfy-link.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"docfy-link.d.ts","sourceRoot":"","sources":["../../src/components/docfy-link.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAI3C,OAAO,KAAK,aAAa,MAAM,+BAA+B,CAAC;AAE/D,UAAU,aAAa;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,kBAAkB;IAC1B,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,iBAAiB,CAAC;IAC3B,MAAM,EAAE;QACN,OAAO,EAAE,EAAE,CAAC;KACb,CAAC;CACH;AAED,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,SAAS,CAAC,kBAAkB,CAAC;IACvC,MAAM,EAAE,aAAa,CAAC;IAEjD,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAIlC;IAED,IAAI,IAAI,IAAI,MAAM,CAWjB;IAED,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAGD,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;CA4BlC"}
+{"version":3,"file":"docfy-link.d.ts","sourceRoot":"","sources":["../../src/components/docfy-link.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAI3C,OAAO,KAAK,aAAa,MAAM,+BAA+B,CAAC;AAE/D,UAAU,aAAa;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,kBAAkB;IAC1B,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,iBAAiB,CAAC;IAC3B,MAAM,EAAE;QACN,OAAO,EAAE,EAAE,CAAC;KACb,CAAC;CACH;AASD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,SAAS,CAAC,kBAAkB,CAAC;IACvC,MAAM,EAAE,aAAa,CAAC;IAEjD;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,IAAI,IAAI,MAAM,CASjB;IAED,IAAI,QAAQ,IAAI,OAAO,CAgBtB;IAGD,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;CAmClC"}

package/dist/components/docfy-link.js

@@ -6,22 +6,40 @@ import { precompileTemplate } from '@ember/template-compilation';
 import { setComponentTemplate } from '@ember/component';
 import { g, i, n } from 'decorator-transforms/runtime';
 
+/** Drop a trailing slash and any query string, so URLs compare by path. */function normalizePath(url) {
+  const path = url.split(/[?#]/)[0] ?? '';
+  return path.length > 1 ? path.replace(/\/+$/, '') : path;
+}
+/**
+ * A link to a Docfy page.
+ *
+ * Docfy addresses pages by URL, and `@to` is already the router's path, so
+ * neither the href nor the active state needs the target route resolved.
+ *
+ * That matters under Embroider's `splitAtRoutes`: `RouterService#recognize()`
+ * resolves the matched route handlers, and resolving a route inside a split
+ * bundle makes `@embroider/router` fetch that bundle. Calling it from a getter
+ * meant that merely rendering a link downloaded the page it pointed at, so a
+ * page linking to every section pulled the whole documentation site up front.
+ * Recognition now happens in `navigate`, where the bundle is about to be needed
+ * anyway.
+ */
 class DocfyLink extends Component {
   static {
     g(this.prototype, "router", [service('router')]);
   }
   #router = (i(this, "router"), void 0);
-  get routeName() {
-    const {
-      to
-    } = this.args;
-    return this.router.recognize(to)?.name;
+  /**
+  * `@to` as the router would produce it. Docfy gives index pages a trailing
+  * slash (`/docs/getting-started/`) where `urlFor` did not, so it is dropped
+  * here to keep the rendered href unchanged.
+  */
+  get path() {
+    return normalizePath(this.args.to);
   }
   get href() {
-    let url = this.args.to;
-    if (this.routeName) {
-      url = this.router.urlFor(this.routeName);
-    }
+    const rootURL = this.router.rootURL?.replace(/\/+$/, '') ?? '';
+    const url = `${rootURL}${this.path}`;
     if (this.args.anchor) {
       return `${url}#${this.args.anchor}`;
     } else {
@@ -29,16 +47,31 @@ class DocfyLink extends Component {
     }
   }
   get isActive() {
-    return this.router.currentRouteName === this.routeName;
+    const {
+      currentURL
+    } = this.router;
+    if (!currentURL) {
+      return false;
+    }
+    // `currentURL` is root-relative, but strip `rootURL` defensively so this
+    // holds however the router reports it.
+    const rootURL = this.router.rootURL?.replace(/\/+$/, '') ?? '';
+    const current = rootURL && currentURL.startsWith(rootURL) ? currentURL.slice(rootURL.length) : currentURL;
+    return normalizePath(current) === this.path;
   }
   navigate(event) {
     if (event.ctrlKey || event.metaKey) {
       return;
     }
-    if (this.routeName && !this.args.anchor) {
-      event.preventDefault();
-      this.router.transitionTo(this.routeName);
+    if (this.args.anchor) {
+      return;
+    }
+    // An unrecognised `@to` is left to the browser, as before.
+    if (!this.router.recognize(this.path)) {
+      return;
     }
+    event.preventDefault();
+    this.router.transitionTo(this.path);
   }
   static {
     n(this.prototype, "navigate", [action]);

package/dist/components/docfy-link.js.map

@@ -1 +1 @@
-{"version":3,"file":"docfy-link.js","sources":["../../src/components/docfy-link.gts"],"sourcesContent":["import Component from '@glimmer/component';\nimport { service } from '@ember/service';\nimport { action } from '@ember/object';\nimport { on } from '@ember/modifier';\nimport type RouterService from '@ember/routing/router-service';\n\ninterface DocfyLinkArgs {\n  to: string;\n  anchor?: string;\n  activeClass?: string;\n}\n\ninterface DocfyLinkSignature {\n  Args: DocfyLinkArgs;\n  Element: HTMLAnchorElement;\n  Blocks: {\n    default: [];\n  };\n}\n\nexport default class DocfyLink extends Component<DocfyLinkSignature> {\n  @service('router') declare router: RouterService;\n\n  get routeName(): string | undefined {\n    const { to } = this.args;\n\n    return this.router.recognize(to)?.name;\n  }\n\n  get href(): string {\n    let url = this.args.to;\n    if (this.routeName) {\n      url = this.router.urlFor(this.routeName);\n    }\n\n    if (this.args.anchor) {\n      return `${url}#${this.args.anchor}`;\n    } else {\n      return url;\n    }\n  }\n\n  get isActive(): boolean {\n    return this.router.currentRouteName === this.routeName;\n  }\n\n  @action\n  navigate(event: MouseEvent): void {\n    if (event.ctrlKey || event.metaKey) {\n      return;\n    }\n\n    if (this.routeName && !this.args.anchor) {\n      event.preventDefault();\n      this.router.transitionTo(this.routeName);\n    }\n  }\n\n  <template>\n    <a\n      class=\"docfy-link {{if this.isActive @activeClass}}\"\n      ...attributes\n      href={{this.href}}\n      data-test-docfy-link\n      data-test-to={{@to}}\n      data-test-anchor={{@anchor}}\n      data-test-is-active={{this.isActive}}\n      {{on \"click\" this.navigate}}\n    >\n      {{yield}}\n    </a>\n  </template>\n}\n"],"names":["DocfyLink","Component","g","prototype","service","i","routeName","to","args","router","recognize","name","href","url","urlFor","anchor","isActive","currentRouteName","navigate","event","ctrlKey","metaKey","preventDefault","transitionTo","n","action","setComponentTemplate","precompileTemplate","strictMode","scope","on"],"mappings":";;;;;;;;AAoBe,MAAMA,kBAAkBC,SAAA,CAAU;AAAA,EAAA;AAAAC,IAAAA,CAAA,MAAAC,SAAA,EAAA,QAAA,EAAA,CAC9CC,OAAA,CAAQ,QAAA,CAAA,CAAA,CAAA;AAAA;EAAA,OAAA,IAAAC,CAAA,CAAA,IAAA,EAAA,QAAA,CAAA,EAAA,MAAA;EAET,IAAIC,SAAAA,GAAgC;IAClC,MAAM;AAAEC,MAAAA;KAAI,GAAG,IAAI,CAACC,IAAI;IAExB,OAAO,IAAI,CAACC,MAAM,CAACC,SAAS,CAACH,EAAA,CAAA,EAAKI,IAAA;AACpC,EAAA;EAEA,IAAIC,IAAAA,GAAe;AACjB,IAAA,IAAIC,GAAA,GAAM,IAAI,CAACL,IAAI,CAACD,EAAE;IACtB,IAAI,IAAI,CAACD,SAAS,EAAE;MAClBO,GAAA,GAAM,IAAI,CAACJ,MAAM,CAACK,MAAM,CAAC,IAAI,CAACR,SAAS,CAAA;AACzC,IAAA;AAEA,IAAA,IAAI,IAAI,CAACE,IAAI,CAACO,MAAM,EAAE;MACpB,OAAO,CAAA,EAAGF,OAAO,IAAI,CAACL,IAAI,CAACO,MAAM,CAAA,CAAE;AACrC,IAAA,CAAA,MAAO;AACL,MAAA,OAAOF,GAAA;AACT,IAAA;AACF,EAAA;EAEA,IAAIG,QAAAA,GAAoB;IACtB,OAAO,IAAI,CAACP,MAAM,CAACQ,gBAAgB,KAAK,IAAI,CAACX,SAAS;AACxD,EAAA;EAGAY,QAAAA,CAASC,KAAiB,EAAQ;AAChC,IAAA,IAAIA,KAAA,CAAMC,OAAO,IAAID,KAAA,CAAME,OAAO,EAAE;AAClC,MAAA;AACF,IAAA;IAEA,IAAI,IAAI,CAACf,SAAS,IAAI,CAAC,IAAI,CAACE,IAAI,CAACO,MAAM,EAAE;MACvCI,KAAA,CAAMG,cAAc,EAAA;MACpB,IAAI,CAACb,MAAM,CAACc,YAAY,CAAC,IAAI,CAACjB,SAAS,CAAA;AACzC,IAAA;AACF,EAAA;AAAA,EAAA;IAAAkB,CAAA,CAAA,IAAA,CAAArB,SAAA,EAAA,UAAA,EAAA,CAVCsB,MAAA,CAAA,CAAA;AAAA;AAYD,EAAA;IAAAC,oBAAA,CAAAC,kBAAA,CAAA,4PAAA,EAaA;MAAAC,UAAA,EAAA,IAAA;AAAAC,MAAAA,KAAA,EAAAA,OAAA;AAAAC,QAAAA;AAAA,OAAA;KAAU,CAAA,EAAV,IAAW,CAAA;AAAD;AACZ;;;;"}
+{"version":3,"file":"docfy-link.js","sources":["../../src/components/docfy-link.gts"],"sourcesContent":["import Component from '@glimmer/component';\nimport { service } from '@ember/service';\nimport { action } from '@ember/object';\nimport { on } from '@ember/modifier';\nimport type RouterService from '@ember/routing/router-service';\n\ninterface DocfyLinkArgs {\n  to: string;\n  anchor?: string;\n  activeClass?: string;\n}\n\ninterface DocfyLinkSignature {\n  Args: DocfyLinkArgs;\n  Element: HTMLAnchorElement;\n  Blocks: {\n    default: [];\n  };\n}\n\n/** Drop a trailing slash and any query string, so URLs compare by path. */\nfunction normalizePath(url: string): string {\n  const path = url.split(/[?#]/)[0] ?? '';\n\n  return path.length > 1 ? path.replace(/\\/+$/, '') : path;\n}\n\n/**\n * A link to a Docfy page.\n *\n * Docfy addresses pages by URL, and `@to` is already the router's path, so\n * neither the href nor the active state needs the target route resolved.\n *\n * That matters under Embroider's `splitAtRoutes`: `RouterService#recognize()`\n * resolves the matched route handlers, and resolving a route inside a split\n * bundle makes `@embroider/router` fetch that bundle. Calling it from a getter\n * meant that merely rendering a link downloaded the page it pointed at, so a\n * page linking to every section pulled the whole documentation site up front.\n * Recognition now happens in `navigate`, where the bundle is about to be needed\n * anyway.\n */\nexport default class DocfyLink extends Component<DocfyLinkSignature> {\n  @service('router') declare router: RouterService;\n\n  /**\n   * `@to` as the router would produce it. Docfy gives index pages a trailing\n   * slash (`/docs/getting-started/`) where `urlFor` did not, so it is dropped\n   * here to keep the rendered href unchanged.\n   */\n  get path(): string {\n    return normalizePath(this.args.to);\n  }\n\n  get href(): string {\n    const rootURL = this.router.rootURL?.replace(/\\/+$/, '') ?? '';\n    const url = `${rootURL}${this.path}`;\n\n    if (this.args.anchor) {\n      return `${url}#${this.args.anchor}`;\n    } else {\n      return url;\n    }\n  }\n\n  get isActive(): boolean {\n    const { currentURL } = this.router;\n\n    if (!currentURL) {\n      return false;\n    }\n\n    // `currentURL` is root-relative, but strip `rootURL` defensively so this\n    // holds however the router reports it.\n    const rootURL = this.router.rootURL?.replace(/\\/+$/, '') ?? '';\n    const current =\n      rootURL && currentURL.startsWith(rootURL)\n        ? currentURL.slice(rootURL.length)\n        : currentURL;\n\n    return normalizePath(current) === this.path;\n  }\n\n  @action\n  navigate(event: MouseEvent): void {\n    if (event.ctrlKey || event.metaKey) {\n      return;\n    }\n\n    if (this.args.anchor) {\n      return;\n    }\n\n    // An unrecognised `@to` is left to the browser, as before.\n    if (!this.router.recognize(this.path)) {\n      return;\n    }\n\n    event.preventDefault();\n    this.router.transitionTo(this.path);\n  }\n\n  <template>\n    <a\n      class=\"docfy-link {{if this.isActive @activeClass}}\"\n      ...attributes\n      href={{this.href}}\n      data-test-docfy-link\n      data-test-to={{@to}}\n      data-test-anchor={{@anchor}}\n      data-test-is-active={{this.isActive}}\n      {{on \"click\" this.navigate}}\n    >\n      {{yield}}\n    </a>\n  </template>\n}\n"],"names":["normalizePath","url","path","split","length","replace","DocfyLink","Component","g","prototype","service","i","args","to","href","rootURL","router","anchor","isActive","currentURL","current","startsWith","slice","navigate","event","ctrlKey","metaKey","recognize","preventDefault","transitionTo","n","action","setComponentTemplate","precompileTemplate","strictMode","scope","on"],"mappings":";;;;;;;;AAoBA,2EACA,SAASA,aAAAA,CAAcC,GAAW,EAAS;AACzC,EAAA,MAAMC,OAAOD,GAAA,CAAIE,KAAK,CAAC,MAAA,CAAO,CAAC,EAAE,IAAI,EAAA;AAErC,EAAA,OAAOD,IAAA,CAAKE,MAAM,GAAG,CAAA,GAAIF,KAAKG,OAAO,CAAC,QAAQ,EAAA,CAAA,GAAMH,IAAA;AACtD;AAEA;;;;;;;;;;;;;;AAce,MAAMI,SAAA,SAAkBC,SAAA,CAAU;AAAA,EAAA;AAAAC,IAAAA,CAAA,MAAAC,SAAA,EAAA,QAAA,EAAA,CAC9CC,OAAA,CAAQ,QAAA,CAAA,CAAA,CAAA;AAAA;EAAA,OAAA,IAAAC,CAAA,CAAA,IAAA,EAAA,QAAA,CAAA,EAAA,MAAA;AAET;;;;;EAKA,IAAIT,IAAAA,GAAe;AACjB,IAAA,OAAOF,aAAA,CAAc,IAAI,CAACY,IAAI,CAACC,EAAE,CAAA;AACnC,EAAA;EAEA,IAAIC,IAAAA,GAAe;AACjB,IAAA,MAAMC,OAAA,GAAU,IAAI,CAACC,MAAM,CAACD,OAAO,EAAEV,OAAA,CAAQ,MAAA,EAAQ,EAAA,CAAA,IAAO,EAAA;IAC5D,MAAMJ,MAAM,CAAA,EAAGc,OAAA,GAAU,IAAI,CAACb,IAAI,CAAA,CAAE;AAEpC,IAAA,IAAI,IAAI,CAACU,IAAI,CAACK,MAAM,EAAE;MACpB,OAAO,CAAA,EAAGhB,OAAO,IAAI,CAACW,IAAI,CAACK,MAAM,CAAA,CAAE;AACrC,IAAA,CAAA,MAAO;AACL,MAAA,OAAOhB,GAAA;AACT,IAAA;AACF,EAAA;EAEA,IAAIiB,QAAAA,GAAoB;IACtB,MAAM;AAAEC,MAAAA;KAAY,GAAG,IAAI,CAACH,MAAM;IAElC,IAAI,CAACG,UAAA,EAAY;AACf,MAAA,OAAO,KAAA;AACT,IAAA;AAEA;AACA;AACA,IAAA,MAAMJ,OAAA,GAAU,IAAI,CAACC,MAAM,CAACD,OAAO,EAAEV,OAAA,CAAQ,MAAA,EAAQ,EAAA,CAAA,IAAO,EAAA;IAC5D,MAAMe,OAAA,GACJL,OAAA,IAAWI,UAAA,CAAWE,UAAU,CAACN,OAAA,CAAA,GAC7BI,UAAA,CAAWG,KAAK,CAACP,OAAA,CAAQX,MAAM,CAAA,GAC/Be,UAAA;AAEN,IAAA,OAAOnB,aAAA,CAAcoB,OAAA,CAAA,KAAa,IAAI,CAAClB,IAAI;AAC7C,EAAA;EAGAqB,QAAAA,CAASC,KAAiB,EAAQ;AAChC,IAAA,IAAIA,KAAA,CAAMC,OAAO,IAAID,KAAA,CAAME,OAAO,EAAE;AAClC,MAAA;AACF,IAAA;AAEA,IAAA,IAAI,IAAI,CAACd,IAAI,CAACK,MAAM,EAAE;AACpB,MAAA;AACF,IAAA;AAEA;IACA,IAAI,CAAC,IAAI,CAACD,MAAM,CAACW,SAAS,CAAC,IAAI,CAACzB,IAAI,CAAA,EAAG;AACrC,MAAA;AACF,IAAA;IAEAsB,KAAA,CAAMI,cAAc,EAAA;IACpB,IAAI,CAACZ,MAAM,CAACa,YAAY,CAAC,IAAI,CAAC3B,IAAI,CAAA;AACpC,EAAA;AAAA,EAAA;IAAA4B,CAAA,CAAA,IAAA,CAAArB,SAAA,EAAA,UAAA,EAAA,CAjBCsB,MAAA,CAAA,CAAA;AAAA;AAmBD,EAAA;IAAAC,oBAAA,CAAAC,kBAAA,CAAA,4PAAA,EAaA;MAAAC,UAAA,EAAA,IAAA;AAAAC,MAAAA,KAAA,EAAAA,OAAA;AAAAC,QAAAA;AAAA,OAAA;KAAU,CAAA,EAAV,IAAW,CAAA;AAAD;AACZ;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docfy/ember",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "The default blueprint for Embroider v2 addons.",
   "keywords": [
     "ember-addon"
@@ -29,7 +29,7 @@
     "prepack": "rollup --config"
   },
   "dependencies": {
-    "@docfy/core": "^0.11.0",
+    "@docfy/core": "^0.12.1",
     "@embroider/addon-shim": "^1.8.9",
     "@embroider/macros": "^1.18.1",
     "decorator-transforms": "^2.3.0"
@@ -39,12 +39,12 @@
   },
   "devDependencies": {
     "@babel/core": "^7.25.2",
-    "@babel/eslint-parser": "^7.25.1",
+    "@babel/eslint-parser": "^8.0.1",
     "@babel/plugin-transform-typescript": "^7.25.2",
     "@babel/runtime": "^7.28.2",
     "@ember/library-tsconfig": "^1.0.0",
     "@embroider/addon-dev": "^8.1.0",
-    "@eslint/js": "^9.32.0",
+    "@eslint/js": "^10.0.1",
     "@glimmer/component": "^2.0.0",
     "@glint/core": "1.5.2",
     "@glint/environment-ember-loose": "1.5.2",
@@ -56,17 +56,17 @@
     "concurrently": "^9.0.1",
     "ember-source": "^6.3.0",
     "ember-template-lint": "^7.9.0",
-    "eslint": "^9.32.0",
+    "eslint": "^10.9.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-ember": "^12.7.0",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-n": "^17.15.1",
-    "globals": "^16.1.0",
-    "prettier": "^3.4.2",
+    "eslint-plugin-ember": "^13.5.0",
+    "eslint-plugin-import-x": "^4.17.1",
+    "eslint-plugin-n": "^18.3.0",
+    "globals": "^17.11.0",
+    "prettier": "^3.9.6",
     "prettier-plugin-ember-template-tag": "^2.1.0",
     "rollup": "^4.22.5",
     "typescript": "~5.8.3",
-    "typescript-eslint": "^8.19.1"
+    "typescript-eslint": "^8.67.0"
   },
   "ember": {
     "edition": "octane"
@@ -105,5 +105,5 @@
       ]
     }
   },
-  "gitHead": "ed6eef49ddb6bfb1ac4c91f94bc4d9291d202130"
+  "gitHead": "e548365e43a1a8b26170d0e5becfb577c113c313"
 }