@docfy/ember 0.9.0 → 0.10.0

package/dist/services/docfy.js

@@ -0,0 +1,87 @@
+
+import Service, { service } from '@ember/service';
+import { cached } from '@glimmer/tracking';
+import output from '@embroider/virtual/docfy/output';
+import { g, i, n } from 'decorator-transforms/runtime';
+
+function flatNested(output, pages = []) {
+  if (typeof output === 'undefined') {
+    return [];
+  }
+  pages.push(...output.pages);
+  output.children.forEach(child => {
+    flatNested(child, pages);
+  });
+  return pages;
+}
+class DocfyService extends Service {
+  static {
+    g(this.prototype, "router", [service('router')]);
+  }
+  #router = (i(this, "router"), void 0);
+  get currentPage() {
+    const currentURL = this.router.currentURL;
+    return currentURL ? this.findByUrl(currentURL) : undefined;
+  }
+  static {
+    n(this.prototype, "currentPage", [cached]);
+  }
+  get flat() {
+    return flatNested(this.nested);
+  }
+  get nested() {
+    return output.nested;
+  }
+  findNestedChildrenByName(scope, previousNested = null) {
+    if (previousNested === null) {
+      previousNested = this.nested;
+    }
+    const parts = scope.split('/');
+    const name = parts.shift();
+    const foundScope = previousNested?.children.find(item => {
+      return item.name === name;
+    });
+    if (parts.length > 0) {
+      return this.findNestedChildrenByName(parts.join('/'), foundScope);
+    }
+    return foundScope;
+  }
+  findByUrl(url, scopeByNestedName) {
+    let pages = this.flat;
+    if (typeof scopeByNestedName === 'string') {
+      pages = flatNested(this.findNestedChildrenByName(scopeByNestedName));
+    }
+    const cleanedUrl = url.split('#')[0] || '';
+    const finalUrl = cleanedUrl.replace(/\/$/, '');
+    return pages.find(item => {
+      return item.url === finalUrl || item.url === `${finalUrl}/`;
+    });
+  }
+  previousPage(scopeByNestedName) {
+    return this.findPreviousOrNextPage(true, scopeByNestedName);
+  }
+  nextPage(scopeByNestedName) {
+    return this.findPreviousOrNextPage(false, scopeByNestedName);
+  }
+  findPreviousOrNextPage(isPrevious, scopeByNestedName) {
+    const currentPage = this.currentPage;
+    let pages = this.flat;
+    if (typeof scopeByNestedName === 'string') {
+      pages = flatNested(this.findNestedChildrenByName(scopeByNestedName));
+    }
+    const index = pages.findIndex(page => {
+      return page === currentPage;
+    });
+    if (index > -1) {
+      if (isPrevious) {
+        return pages[index - 1];
+      } else {
+        return pages[index + 1];
+      }
+    }
+    return undefined;
+  }
+}
+
+export { DocfyService as default };
+//# sourceMappingURL=docfy.js.map

package/dist/services/docfy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docfy.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/template-registry.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=template-registry.js.map

package/dist/template-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-registry.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -1,141 +1,108 @@
 {
   "name": "@docfy/ember",
-  "version": "0.9.0",
-  "description": "Ember integration with Docfy",
+  "version": "0.10.0",
+  "description": "The default blueprint for Embroider v2 addons.",
   "keywords": [
-    "ember-addon",
-    "prember-plugin"
+    "ember-addon"
   ],
-  "repository": "https://github.com/josemarluedke/docfy",
+  "repository": "",
   "license": "MIT",
-  "author": "Josemar Luedke <josemarluedke@gmail.com>",
-  "directories": {
-    "doc": "docs",
-    "test": "tests"
-  },
+  "author": "",
+  "files": [
+    "addon-main.cjs",
+    "declarations",
+    "dist"
+  ],
   "scripts": {
-    "prebuild": "npm-run-all compile",
-    "build": "ember build --environment=production",
-    "compile": "tsc --project src/tsconfig.json",
-    "lint": "npm-run-all --aggregate-output --continue-on-error --parallel lint:*",
-    "lint:hbs": "ember-template-lint .",
-    "lint:js": "cd ../../../ && yarn lint:js",
-    "prepare": "npm-run-all compile",
-    "prepublishOnly": "ember ts:precompile",
-    "postpublish": "ember ts:clean",
-    "prestart": "npm-run-all compile",
-    "start": "ember serve",
-    "test": "npm-run-all lint:hbs test:*",
-    "test:ember": "ember test --test-port=",
-    "test:ember-compatibility": "echo 'ember try:each TODO'"
+    "build": "rollup --config",
+    "compile": "rollup --config",
+    "format": "prettier . --cache --write",
+    "format:check": "prettier . --cache --check",
+    "lint": "concurrently \"yarn:lint:js\" \"yarn:lint:hbs\" \"yarn:lint:types\" \"yarn:lint:format\" --names \"lint:\" --prefixColors auto",
+    "lint:fix": "concurrently \"yarn:lint:*:fix\" --names \"fix:\" --prefixColors auto && yarn format",
+    "lint:format": "prettier . --cache --check",
+    "lint:hbs": "ember-template-lint . --no-error-on-unmatched-pattern",
+    "lint:js": "eslint . --cache",
+    "lint:hbs:fix": "ember-template-lint . --fix --no-error-on-unmatched-pattern",
+    "lint:js:fix": "eslint . --fix",
+    "lint:types": "glint",
+    "prepack": "rollup --config"
   },
   "dependencies": {
-    "@docfy/core": "^0.9.0",
-    "broccoli-bridge": "^1.0.0",
-    "broccoli-file-creator": "^2.1.1",
-    "broccoli-funnel": "^3.0.8",
-    "broccoli-merge-trees": "^4.2.0",
-    "broccoli-node-api": "^1.7.0",
-    "broccoli-plugin": "^4.0.7",
-    "broccoli-source": "^3.0.1",
-    "calculate-cache-key-for-tree": "2.0.0",
-    "debug": "^4.3.3",
-    "ember-cli-babel": "^8.2.0",
-    "ember-cli-htmlbars": "^6.3.0",
-    "ember-cli-typescript": "^4.2.1",
-    "ember-get-config": "^1.0.2",
-    "mdast-util-to-string": "^2.0.0",
-    "remark-hbs": "^0.4.1",
-    "unist-builder": "^2.0.3",
-    "unist-util-find": "^1.0.2",
-    "unist-util-visit": "^2.0.2"
-  },
-  "devDependencies": {
-    "@babel/helper-define-map": "^7.16.7",
-    "@docfy/plugin-with-prose": "^0.9.0",
-    "@ember/optional-features": "^2.0.0",
-    "@ember/test-helpers": "^2.6.0",
-    "@embroider/compat": "^1.0.0",
-    "@embroider/core": "^1.0.0",
-    "@embroider/webpack": "^1.0.0",
-    "@glimmer/component": "^1.0.4",
-    "@glimmer/tracking": "^1.0.4",
-    "@mapbox/rehype-prism": "^0.5.0",
-    "@tailwindcss/typography": "^0.4.0",
-    "@types/ember-qunit": "^5.0.0",
-    "@types/ember-resolver": "^5.0.11",
-    "@types/ember__application": "^4.0.0",
-    "@types/ember__array": "^4.0.1",
-    "@types/ember__component": "^4.0.1",
-    "@types/ember__debug": "^4.0.0",
-    "@types/ember__error": "^4.0.0",
-    "@types/ember__object": "^4.0.0",
-    "@types/ember__routing": "^4.0.2",
-    "@types/ember__runloop": "^4.0.0",
-    "@types/ember__service": "^4.0.0",
-    "@types/ember__string": "^3.0.9",
-    "@types/ember__template": "^4.0.0",
-    "@types/ember__test": "^4.0.0",
-    "@types/ember__test-helpers": "^2.6.1",
-    "@types/htmlbars-inline-precompile": "^3.0.0",
-    "@types/qunit": "^2.11.3",
-    "@types/rsvp": "^4.0.4",
-    "@types/sinon": "^9.0.10",
-    "autoprefixer": "^10.4.2",
-    "broccoli-asset-rev": "^3.0.0",
-    "ember-auto-import": "^2.4.0",
-    "ember-cli": "~4.1.1",
-    "ember-cli-babel": "8.2.0",
-    "ember-cli-dependency-checker": "^3.2.0",
-    "ember-cli-fastboot": "^3.2.0-beta.5",
-    "ember-cli-fastboot-testing": "^0.6.0",
-    "ember-cli-inject-live-reload": "^2.1.0",
-    "ember-cli-postcss": "^8.0.0",
-    "ember-cli-sri": "^2.1.1",
-    "ember-cli-typescript-blueprints": "^3.0.0",
-    "ember-cli-uglify": "^3.0.0",
-    "ember-disable-prototype-extensions": "^1.1.3",
-    "ember-export-application-global": "^2.0.1",
-    "ember-load-initializers": "^2.1.2",
-    "ember-maybe-import-regenerator": "^1.0.0",
-    "ember-qunit": "^5.1.5",
-    "ember-resolver": "^8.0.3",
-    "ember-router-helpers": "^0.4.0",
-    "ember-sinon": "^5.0.0",
-    "ember-source": "~4.1.0",
-    "ember-source-channel-url": "^3.0.0",
-    "ember-template-imports": "^4.0.0",
-    "ember-template-lint": "^2.18.0",
-    "ember-try": "^2.0.0",
-    "loader.js": "^4.7.0",
-    "npm-run-all": "^4.1.5",
-    "postcss-import": "^14.0.2",
-    "postcss-nested": "^5.0.6",
-    "prember": "^1.1.0",
-    "qunit": "^2.17.2",
-    "qunit-dom": "^2.0.0",
-    "refractor": "^3.0.0",
-    "remark-autolink-headings": "^6.0.0",
-    "remark-code-import": "^0.2.0",
-    "tailwindcss": "^2.0.2",
-    "typescript": "^4.1.3",
-    "webpack": "^5.67.0"
+    "@embroider/addon-shim": "^1.8.9",
+    "@embroider/macros": "^1.18.0",
+    "decorator-transforms": "^2.3.0"
   },
-  "engines": {
-    "node": ">= 12"
+  "peerDependencies": {
+    "ember-source": ">= 4.12.0"
   },
-  "publishConfig": {
-    "access": "public"
+  "devDependencies": {
+    "@babel/core": "^7.25.2",
+    "@babel/eslint-parser": "^7.25.1",
+    "@babel/plugin-transform-typescript": "^7.25.2",
+    "@babel/runtime": "^7.25.6",
+    "@ember/library-tsconfig": "^1.0.0",
+    "@embroider/addon-dev": "^8.1.0",
+    "@eslint/js": "^9.17.0",
+    "@glimmer/component": "^2.0.0",
+    "@glint/core": "1.5.2",
+    "@glint/environment-ember-loose": "1.5.2",
+    "@glint/environment-ember-template-imports": "1.5.2",
+    "@glint/template": "1.5.2",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@types/qunit": "^2.19.12",
+    "babel-plugin-ember-template-compilation": "^3.0.0",
+    "concurrently": "^9.0.1",
+    "ember-source": "^6.3.0",
+    "ember-template-lint": "^7.9.0",
+    "eslint": "^9.17.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-ember": "^12.3.3",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-n": "^17.15.1",
+    "globals": "^16.1.0",
+    "prettier": "^3.4.2",
+    "prettier-plugin-ember-template-tag": "^2.0.4",
+    "rollup": "^4.22.5",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.19.1"
   },
   "ember": {
     "edition": "octane"
   },
   "ember-addon": {
-    "configPath": "tests/dummy/config",
-    "main": "ember-cli-addon.js",
-    "before": [
-      "prember"
-    ]
+    "version": 2,
+    "type": "addon",
+    "main": "addon-main.cjs",
+    "app-js": {
+      "./components/docfy-demo.js": "./dist/_app_/components/docfy-demo.js",
+      "./components/docfy-link.js": "./dist/_app_/components/docfy-link.js",
+      "./components/docfy-output.js": "./dist/_app_/components/docfy-output.js",
+      "./components/docfy-previous-and-next-page.js": "./dist/_app_/components/docfy-previous-and-next-page.js",
+      "./services/docfy.js": "./dist/_app_/services/docfy.js"
+    }
+  },
+  "imports": {
+    "#src/*": "./src/*"
+  },
+  "exports": {
+    ".": {
+      "types": "./declarations/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./*.css": "./dist/*.css",
+    "./*": {
+      "types": "./declarations/*.d.ts",
+      "default": "./dist/*.js"
+    },
+    "./addon-main.js": "./addon-main.cjs"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "declarations/*"
+      ]
+    }
   },
-  "gitHead": "7084e3983d67d3d0d704a2aa13cd31341e6aaa4f"
+  "gitHead": "02bfa7220969ce5585709d43ffaa5c8b3f9c1819"
 }

package/-private/find-previous-or-next-page.d.ts

@@ -1,2 +0,0 @@
-import { NestedPageMetadata, PageMetadata } from '@docfy/core/lib/types';
-export default function findPreviousOrNextPage(url: string, isPrevious: boolean, nested: NestedPageMetadata): PageMetadata | undefined;

package/-private/flat-nested.d.ts

@@ -1,2 +0,0 @@
-import { NestedPageMetadata, PageMetadata } from '@docfy/core/lib/types';
-export default function flatNested(output?: NestedPageMetadata, pages?: PageMetadata[]): PageMetadata[];

package/.docfy-config.js

@@ -1,40 +0,0 @@
-const path = require('path');
-const autolinkHeadings = require('remark-autolink-headings');
-const prism = require('@mapbox/rehype-prism');
-const refractor = require('refractor');
-const docfyWithProse = require('@docfy/plugin-with-prose');
-
-refractor.alias('handlebars', 'hbs');
-refractor.alias('shell', 'sh');
-
-module.exports = {
-  remarkHbsOptions: {
-    escapeCurliesCode: false
-  },
-  remarkPlugins: [
-    [
-      autolinkHeadings,
-      {
-        behavior: 'wrap'
-      }
-    ]
-  ],
-  plugins: [docfyWithProse],
-  rehypePlugins: [() => [prism, { alias: { gts: 'ts', gjs: 'js' } }]],
-  sources: [
-    {
-      root: path.join(__dirname, 'dummy-docs'),
-      pattern: '**/*.md',
-      urlSchema: 'manual',
-      urlPrefix: 'docs'
-    }
-  ],
-  labels: {
-    components: 'Components',
-    plugins: 'Plugins',
-    helpers: 'Helpers',
-    core: '@docfy/core',
-    ember: '@docfy/ember',
-    docs: 'Documentation'
-  }
-};

package/addon/-private/find-previous-or-next-page.ts

@@ -1,22 +0,0 @@
-import { NestedPageMetadata, PageMetadata } from '@docfy/core/lib/types';
-import flatNested from './flat-nested';
-
-export default function findPreviousOrNextPage(
-  url: string,
-  isPrevious: boolean,
-  nested: NestedPageMetadata
-): PageMetadata | undefined {
-  const flat = flatNested(nested);
-  const index = flat.findIndex((page) => {
-    return page.url === url || page.url === `${url}/`;
-  });
-
-  if (index > -1) {
-    if (isPrevious) {
-      return flat[index - 1];
-    } else {
-      return flat[index + 1];
-    }
-  }
-  return undefined;
-}

package/addon/-private/flat-nested.ts

@@ -1,18 +0,0 @@
-import { NestedPageMetadata, PageMetadata } from '@docfy/core/lib/types';
-
-export default function flatNested(
-  output?: NestedPageMetadata,
-  pages: PageMetadata[] = []
-): PageMetadata[] {
-  if (typeof output === 'undefined') {
-    return [];
-  }
-
-  pages.push(...output.pages);
-
-  output.children.forEach((child) => {
-    flatNested(child, pages);
-  });
-
-  return pages;
-}

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

@@ -1,26 +0,0 @@
-<div class="docfy-demo__description" ...attributes>
-  <div class="docfy-demo__description__header">
-    {{#if @title}}
-      <h3 class="docfy-demo__description__header__title">
-        <a href="#{{@id}}">
-          <span class="icon icon-link"></span>
-        </a>
-        {{@title}}
-      </h3>
-    {{/if}}
-    {{#if @editUrl}}
-      <a
-        href="{{@editUrl}}"
-        target="_blank"
-        rel="noopener noreferrer"
-        class="docfy-demo__description__header__edit-url"
-      >
-        Edit this demo
-      </a>
-    {{/if}}
-  </div>
-
-  <div class="docfy-demo__description__content">
-    {{yield}}
-  </div>
-</div>

package/addon/components/docfy-demo/description.ts

@@ -1,3 +0,0 @@
-import Component from '@glimmer/component';
-
-export default class DocfyDemoDescription extends Component {}

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

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

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

@@ -1,3 +0,0 @@
-import Component from '@glimmer/component';
-
-export default class DocfyDemoExample extends Component {}

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

@@ -1,8 +0,0 @@
-{{#if this.isActive}}
-  <div
-    class="docfy-demo__snippet"
-    ...attributes
-  >
-    {{yield}}
-  </div>
-{{/if}}

package/addon/components/docfy-demo/snippet.ts

@@ -1,35 +0,0 @@
-import Component from '@glimmer/component';
-import { guidFor } from '@ember/object/internals';
-import { SnippetRegisterArgs } from './snippets';
-
-interface DocfyDemoSnippetArgs {
-  name: string;
-  active: string;
-  registerSnippet: (snippet: SnippetRegisterArgs) => void;
-}
-
-export default class DocfyDemoSnippet extends Component<DocfyDemoSnippetArgs> {
-  id = guidFor(this);
-
-  constructor(owner: unknown, args: DocfyDemoSnippetArgs) {
-    super(owner, args);
-
-    if (typeof this.args.registerSnippet === 'function') {
-      let name = this.args.name || '';
-      name = name.charAt(0).toUpperCase() + name.slice(1);
-
-      this.args.registerSnippet({
-        id: this.id,
-        name
-      });
-    }
-  }
-
-  get isActive(): boolean {
-    if (typeof this.args.registerSnippet !== 'function') {
-      return true;
-    }
-
-    return this.id === this.args.active;
-  }
-}

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

@@ -1,25 +0,0 @@
-<div class="docfy-demo__snippets">
-  <div class="docfy-demo__snippets__tabs">
-    {{#each this.snippets as |snippet|}}
-      <button
-        type="button"
-        class="docfy-demo__snippets__tabs__button {{
-          if
-          (docfy-eq this.active snippet.id)
-          "docfy-demo__snippets__tabs__button--active"
-        }}"
-        {{on "click" (fn this.setActiveSnippet snippet.id)}}
-      >
-        {{snippet.name}}
-      </button>
-    {{/each}}
-  </div>
-
-  {{yield
-    (component
-      "docfy-demo/snippet"
-      registerSnippet=this.registerSnippet
-      active=this.active
-    )
-  }}
-</div>

package/addon/components/docfy-demo/snippets.ts

@@ -1,27 +0,0 @@
-import Component from '@glimmer/component';
-import { tracked } from '@glimmer/tracking';
-import { action } from '@ember/object';
-import { schedule } from '@ember/runloop';
-
-export interface SnippetRegisterArgs {
-  id: string;
-  name: string;
-}
-
-export default class DocfyDemoSnippets extends Component {
-  @tracked snippets: SnippetRegisterArgs[] = [];
-  @tracked active?: string;
-
-  @action registerSnippet(snippet: SnippetRegisterArgs): void {
-    schedule('render', this, () => {
-      this.snippets = [...this.snippets, snippet];
-      if (!this.active) {
-        this.active = snippet.id;
-      }
-    });
-  }
-
-  @action setActiveSnippet(id: string): void {
-    this.active = id;
-  }
-}

package/addon/components/docfy-demo.hbs

@@ -1,10 +0,0 @@
-<div id={{@id}} class="docfy-demo" ...attributes>
-  {{yield
-    (hash
-      Example=(component "docfy-demo/example")
-      Description=(component "docfy-demo/description" id=@id)
-      Snippet=(component "docfy-demo/snippet")
-      Snippets=(component "docfy-demo/snippets")
-    )
-  }}
-</div>

package/addon/components/docfy-demo.ts

@@ -1,7 +0,0 @@
-import Component from '@glimmer/component';
-
-interface DocfyDemoArgs {
-  id: string;
-}
-
-export default class DocfyDemo extends Component<DocfyDemoArgs> {}

package/addon/components/docfy-link.hbs

@@ -1,8 +0,0 @@
-<a
-  class="{{if this.isActive @activeClass}}"
-  ...attributes
-  href={{this.href}}
-  {{on "click" this.navigate}}
->
-  {{~yield~}}
-</a>

package/addon/components/docfy-link.ts

@@ -1,54 +0,0 @@
-import Component from '@glimmer/component';
-import { inject as service } from '@ember/service';
-import { action } from '@ember/object';
-import RouterService from '@ember/routing/router-service';
-import config from 'ember-get-config';
-
-interface DocfyLinkArgs {
-  to: string;
-  anchor?: string;
-  activeClass?: string;
-}
-
-export default class DocfyLink extends Component<DocfyLinkArgs> {
-  @service router!: RouterService;
-
-  get routeName(): string {
-    let { to } = this.args;
-
-    if (config.rootURL && config.rootURL !== '/') {
-      to = to.replace(/^\//, config.rootURL);
-    }
-
-    return (this.router as any).recognize(to)?.name; // eslint-disable-line
-  }
-
-  get href(): string {
-    let url = this.args.to;
-    if (this.routeName) {
-      url = this.router.urlFor(this.routeName);
-    }
-
-    if (this.args.anchor) {
-      return `${url}#${this.args.anchor}`;
-    } else {
-      return url;
-    }
-  }
-
-  get isActive(): boolean {
-    return this.router.currentRouteName === this.routeName;
-  }
-
-  @action
-  navigate(event: MouseEvent): void {
-    if (event.ctrlKey || event.metaKey) {
-      return;
-    }
-
-    if (this.routeName && !this.args.anchor) {
-      event.preventDefault();
-      this.router.transitionTo(this.routeName);
-    }
-  }
-}

package/addon/components/docfy-output.hbs

@@ -1 +0,0 @@
-{{yield this.output}}