Merge pull request #24 from universal-ember/sort-tree-and-json-c

Sort trees and json C

docs-app/app/routes/index.js

@@ -0,0 +1,10 @@
+import Route from '@ember/routing/route';
+import { service } from '@ember/service';
+
+export default class NotHere extends Route {
+  @service router;
+
+  beforeModel() {
+    this.router.replaceWith('/usage/setup.md');
+  }
+}

docs-app/public/docs/components/api-docs.md

@@ -1,5 +1,5 @@
 # `<APIDocs />`
 
-```hbs live
+```hbs live no-shadow
 <APIDocs @module="declarations/browser/re-exports" @name="APIDocs" @apiDocs="/docs/kolay.json" />
 ```

docs-app/public/docs/components/meta.json

@@ -0,0 +1,3 @@
+{
+  "order": ["component-signature", "api-docs", "logs"]
+}

docs-app/public/docs/meta.jsonc

@@ -0,0 +1,5 @@
+{
+  // We want usage to be first, which breaks the
+  // default sort order provided by the filesystem: Alphabetical
+  "order": ["usage", "components", "plugins"],
+}

docs-app/public/docs/plugins/create-manifest.md

@@ -1,9 +1,16 @@
 # `createManifest(...)`
 
-```hbs live
+## Config
+
+either json or jsonc
+
+- set order
+- change name
+
+```hbs live no-shadow
 <APIDocs @module="declarations/plugins/vite" @name="createManifest" @apiDocs="/docs/kolay.json" />
 ```
 
-```hbs live
+```hbs live no-shadow
 <APIDocs @module="src/plugins/types" @name="CreateManifestOptions" @apiDocs="/docs/kolay.json" />
 ```

fixtures/discover/README.md

@@ -0,0 +1 @@
+currently, top level pages are not allowed - everything must be in a folder

fixtures/discover/c/e/meta.json

@@ -0,0 +1,3 @@
+{
+  "order": ["e-b", "e-a"]
+}

fixtures/discover/c/meta.jsonc

@@ -0,0 +1,3 @@
+{
+  "order": ["c-b", "c-a"],
+}

fixtures/discover/meta.jsonc

@@ -0,0 +1,3 @@
+{
+  "order": ["b", "a"],
+}

package.json

@@ -70,6 +70,7 @@
     "@tsconfig/ember": "^3.0.3",
     "@zamiell/typedoc-plugin-not-exported": "^0.2.0",
     "globby": "^14.0.0",
+    "json5": "^2.2.3",
     "package-up": "^5.0.0",
     "typedoc": "^0.25.8",
     "unplugin": "^1.6.0"

src/plugins/create-manifest/discover.js

@@ -0,0 +1,33 @@
+import { reshape } from './hydrate.js';
+
+/**
+ * @typedef {object} Options
+ * @property {string | undefined} [ include ]
+ * @property {string[] | undefined} [ exclude ]
+ * @property {string} cwd
+ * @property {boolean | undefined} [ onlyDirectories ]
+ *
+ * @param {Options} options
+ */
+export async function discover({ include, onlyDirectories, exclude, cwd }) {
+  include ??= '**/*';
+  exclude ??= [];
+  onlyDirectories ??= false;
+
+  const { globbySync } = await import('globby');
+
+  let paths = globbySync(include, {
+    cwd,
+    expandDirectories: true,
+    onlyDirectories,
+  });
+
+  // Needs to be const, because TS thinks exclude can change while `filter` is running.
+  const excludePattern = exclude;
+
+  paths = paths.filter((path) => !excludePattern.some((pattern) => path.match(pattern)));
+
+  const reshaped = await reshape(paths, cwd);
+
+  return reshaped;
+}

src/plugins/create-manifest/discover.test.ts

@@ -0,0 +1,79 @@
+import path from 'node:path';
+import url from 'node:url';
+
+import { describe, expect, test } from 'vitest';
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+
+import { discover } from './discover.js';
+
+const fixtures = path.join(__dirname, '../../../fixtures/discover');
+
+describe('discover', () => {
+  test('it works', async () => {
+    let result = await discover({ cwd: fixtures });
+
+    expect(result.tree).toMatchInlineSnapshot(`
+      {
+        "first": "/c/c-b.md",
+        "name": "root",
+        "pages": [
+          {
+            "first": "/c/c-b.md",
+            "name": "c",
+            "pages": [
+              {
+                "groupName": "c",
+                "name": "c-b",
+                "path": "/c/c-b.md",
+                "tutorialName": "cb",
+              },
+              {
+                "groupName": "c",
+                "name": "c-a",
+                "path": "/c/c-a.md",
+                "tutorialName": "ca",
+              },
+              {
+                "first": "/c/d/d-a.md",
+                "name": "d",
+                "pages": [
+                  {
+                    "groupName": "d",
+                    "name": "d-a",
+                    "path": "/c/d/d-a.md",
+                    "tutorialName": "da",
+                  },
+                  {
+                    "groupName": "d",
+                    "name": "d-b",
+                    "path": "/c/d/d-b.md",
+                    "tutorialName": "db",
+                  },
+                ],
+              },
+              {
+                "first": "/c/e/e-b.md",
+                "name": "e",
+                "pages": [
+                  {
+                    "groupName": "e",
+                    "name": "e-b",
+                    "path": "/c/e/e-b.md",
+                    "tutorialName": "eb",
+                  },
+                  {
+                    "groupName": "e",
+                    "name": "e-a",
+                    "path": "/c/e/e-a.md",
+                    "tutorialName": "ea",
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+      }
+    `);
+  });
+});

src/plugins/create-manifest/hydrate.js

@@ -1,11 +1,15 @@
-import { parse } from './parse.js';
+import { configsFrom, parse } from './parse.js';
+import { sortTree } from './sort.js';
 
 /**
  * @param {string[]} paths
  * @param {string} cwd path on disk that the paths are relative to - needed for looking up configs
  */
 export async function reshape(paths, cwd) {
   let tree = await parse(paths, cwd);
+  let configs = await configsFrom(paths, cwd);
+
+  tree = sortTree(tree, configs);
 
   addInTheFirstPage(tree);
 

src/plugins/create-manifest/index.js

@@ -2,7 +2,7 @@ import assert from 'node:assert';
 
 import { createUnplugin } from 'unplugin';
 
-import { reshape } from './hydrate.js';
+import { discover } from './discover.js';
 
 /**
  *
@@ -25,26 +25,11 @@ export const createManifest = createUnplugin(
       name: 'create-manifest',
       async buildStart() {
         name ??= 'manifest.json';
-        include ??= '**/*';
-        exclude ??= [];
         onlyDirectories ??= false;
 
         const path = await import('node:path');
-        const { globbySync } = await import('globby');
-
         const cwd = src ? path.join(process.cwd(), src) : process.cwd();
-        let paths = globbySync(include, {
-          cwd,
-          expandDirectories: true,
-          onlyDirectories,
-        });
-
-        // Needs to be const, because TS thinks exclude can change while `filter` is running.
-        const excludePattern = exclude;
-
-        paths = paths.filter((path) => !excludePattern.some((pattern) => path.match(pattern)));
-
-        const reshaped = await reshape(paths, cwd);
+        const reshaped = await discover({ cwd, onlyDirectories, exclude, include });
 
         this.emitFile({
           type: 'asset',

src/plugins/create-manifest/parse.build.test.ts

@@ -15,7 +15,7 @@ describe('build', () => {
             "pages": [
               {
                 "groupName": "top",
-                "name": "nested.md",
+                "name": "nested",
                 "path": "/top/nested.md",
                 "tutorialName": "nested",
               },
@@ -42,19 +42,19 @@ describe('build', () => {
             "pages": [
               {
                 "groupName": "top",
-                "name": "nested.md",
+                "name": "nested",
                 "path": "/top/nested.md",
                 "tutorialName": "nested",
               },
               {
                 "groupName": "top",
-                "name": "nested-sibling.md",
+                "name": "nested-sibling",
                 "path": "/top/nested-sibling.md",
                 "tutorialName": "nestedsibling",
               },
               {
                 "groupName": "top",
-                "name": "other.md",
+                "name": "other",
                 "path": "/top-2/other.md",
                 "tutorialName": "other",
               },
@@ -80,7 +80,7 @@ describe('build', () => {
                 "pages": [
                   {
                     "groupName": "deep",
-                    "name": "path.md",
+                    "name": "path",
                     "path": "/top/deep/path.md",
                     "tutorialName": "path",
                   },
@@ -115,7 +115,7 @@ describe('build', () => {
                     "pages": [
                       {
                         "groupName": "another",
-                        "name": "index.md",
+                        "name": "index",
                         "path": "/top/deep/another/index.md",
                         "tutorialName": "index",
                       },