Fix the docs app after converting to a monorepo

This commit covers part 2 of the Embroider V2 addon conversion guide See: https://github.com/embroider-build/embroider/blob/main/docs/porting-addons-to-v2.md
SanderKnauff · Jan 14, 2024 · ff4e8af · ff4e8af
1 parent 56e6557
commit ff4e8af
Show file tree

Hide file tree

Showing 9 changed files with 81 additions and 124 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -107,5 +107,6 @@ jobs:
         working-directory: docs
       - name: Build including API docs
         run: pnpm run docs:build
+        working-directory: docs
       # TODO: Perform some basic steps that the build contains API docs
       #       and works as expected.
diff --git a/addon/package.json b/addon/package.json
@@ -50,7 +50,6 @@
     "ember-render-helpers": "^0.2.0",
     "ember-style-modifier": "^0.8.0 || ^1.0.0 || ^2.0.0 || ^3.0.0",
     "findup-sync": "^5.0.0",
-    "fs-extra": "^11.0.0",
     "resolve": "^1.18.1",
     "silent-error": "^1.0.1",
     "tracked-toolbox": "^1.2.3 || ^2.0.0"
@@ -77,18 +76,6 @@
   "engines": {
     "node": "18.* || >= 20"
   },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  },
-  "changelog": {
-    "labels": {
-      "breaking": ":boom: Breaking Change",
-      "enhancement": "Features",
-      "bug": "Bug Fixes",
-      "documentation": "Documentation",
-      "internal": "Internal"
-    }
-  },
   "ember": {
     "edition": "octane"
   },
@@ -98,19 +85,7 @@
     },
     "demoURL": "https://www.ember-bootstrap.com"
   },
-  "release-it": {
-    "plugins": {
-      "@release-it-plugins/lerna-changelog": {
-        "infile": "CHANGELOG.md",
-        "launchEditor": true
-      }
-    },
-    "git": {
-      "tagName": "v${version}"
-    },
-    "github": {
-      "release": true,
-      "tokenRef": "GITHUB_AUTH"
-    }
+  "volta": {
+    "extends": "../package.json"
   }
 }
diff --git a/test-app/gulpfile.js → docs/gulpfile.js b/test-app/gulpfile.js → docs/gulpfile.js
@@ -14,9 +14,7 @@ gulp.task('docs:api', function () {
 });
 
 gulp.task('docs:app', function () {
-  return execa('ember', ['build', '--prod'], {
-    cwd: 'docs',
-  }).catch((e) => {
+  return execa('ember', ['build', '--prod']).catch((e) => {
     console.error(e);
     throw e;
   });

diff --git a/docs/package.json b/docs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ember-bootstrap-docs",
-  "version": "0.0.0",
+  "version": "6.1.0",
   "private": true,
   "description": "ember-bootstrap docs",
   "repository": "https://github.com/kaliber5/ember-bootstrap",
@@ -11,6 +11,8 @@
     "test": "tests"
   },
   "scripts": {
+    "docs:build": "gulp docs:build",
+    "docs:serve": "gulp docs:serve",
     "build": "ember build --environment=production",
     "lint": "concurrently \"npm:lint:*(!fix)\" --names \"lint:\"",
     "lint:css": "stylelint \"**/*.scss\"",
@@ -49,6 +51,7 @@
     "ember-cli-showdown": "7.0.0",
     "ember-cli-sri": "2.1.1",
     "ember-cli-terser": "4.0.2",
+    "ember-cli-yuidoc": "0.9.1",
     "ember-code-snippet": "3.0.0",
     "ember-cp-validations": "6.0.0",
     "ember-fetch": "8.1.2",
@@ -69,13 +72,21 @@
     "eslint-plugin-n": "16.6.2",
     "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-qunit": "8.0.1",
+    "execa": "5.1.1",
+    "gulp": "4.0.2",
+    "gulp-connect": "5.7.0",
+    "gulp-insert": "0.5.0",
+    "gulp-rename": "2.0.0",
+    "gulp-transform": "3.0.5",
     "loader.js": "4.7.0",
+    "merge-stream": "2.0.0",
     "prember": "2.0.0",
     "prettier": "3.0.3",
     "qunit": "2.20.0",
     "qunit-dom": "3.0.0",
     "sass": "1.69.7",
     "sinon": "17.0.1",
+    "striptags": "3.2.0",
     "stylelint": "16.1.0",
     "stylelint-config-standard-scss": "13.0.0",
     "stylelint-prettier": "5.0.0",
@@ -90,11 +101,10 @@
   },
   "ember-addon": {
     "paths": [
-      ".."
+      "../addon"
     ]
   },
   "volta": {
-    "node": "18.19.0",
-    "pnpm": "8.14.1"
+    "extends": "../package.json"
   }
 }
diff --git a/test-app/yuidoc.json → docs/yuidoc.json b/test-app/yuidoc.json → docs/yuidoc.json
@@ -4,14 +4,14 @@
   "version": "3.1.3",
   "options": {
     "paths": [
-      "addon/components",
-      "addon/mixins"
+      "../addon/addon/components",
+      "../addon/addon/mixins"
     ],
     "exclude": "vendor",
-    "outdir": "docs/api",
-    "themedir": "docs/yuidoc-theme",
+    "outdir": "api",
+    "themedir": "yuidoc-theme",
     "helpers": [
-      "docs/yuidoc-theme/helpers/index.js"
+      "yuidoc-theme/helpers/index.js"
     ]
   }
 }
diff --git a/package.json b/package.json
@@ -12,6 +12,33 @@
   "lint-staged": {
     "*.js": "eslint --cache --fix"
   },
+  "changelog": {
+    "labels": {
+      "breaking": ":boom: Breaking Change",
+      "enhancement": "Features",
+      "bug": "Bug Fixes",
+      "documentation": "Documentation",
+      "internal": "Internal"
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "release-it": {
+    "plugins": {
+      "@release-it-plugins/lerna-changelog": {
+        "infile": "CHANGELOG.md",
+        "launchEditor": true
+      }
+    },
+    "git": {
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true,
+      "tokenRef": "GITHUB_AUTH"
+    }
+  },
   "volta": {
     "node": "18.19.0",
     "pnpm": "8.14.1"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test-app/renovate.json → renovate.json b/test-app/renovate.json → renovate.json
diff --git a/test-app/package.json b/test-app/package.json
@@ -22,8 +22,6 @@
   "scripts": {
     "build": "ember build --environment=production",
     "changelog": "lerna-changelog",
-    "docs:build": "gulp docs:build",
-    "docs:serve": "gulp docs:serve",
     "lint": "concurrently \"npm:lint:*(!fix)\" --names \"lint:\"",
     "lint:fix": "concurrently \"npm:lint:*:fix\" --names \"fix:\"",
     "lint:hbs": "ember-template-lint .",
@@ -36,9 +34,6 @@
     "test:ember": "ember test",
     "test:ember-compatibility": "ember try:each"
   },
-  "lint-staged": {
-    "*.js": "eslint --cache --fix"
-  },
   "dependencies": {
     "@ember/render-modifiers": "^2.0.0",
     "@embroider/macros": "^1.0.0",
@@ -94,7 +89,7 @@
     "ember-cli-sri": "2.1.1",
     "ember-cli-terser": "4.0.2",
     "ember-cli-test-loader": "3.1.0",
-    "ember-cli-yuidoc": "0.9.1",
+    "ember-cli-version-checker": "^5.1.2",
     "ember-compatibility-helpers": "1.2.7",
     "ember-load-initializers": "2.1.2",
     "ember-page-title": "8.2.0",
@@ -114,24 +109,15 @@
     "eslint-plugin-n": "16.6.2",
     "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-qunit": "8.0.1",
-    "execa": "5.1.1",
-    "glob": "10.3.10",
-    "gulp": "4.0.2",
-    "gulp-connect": "5.7.0",
-    "gulp-insert": "0.5.0",
-    "gulp-rename": "2.0.0",
-    "gulp-transform": "3.0.5",
-    "husky": "8.0.3",
-    "lint-staged": "15.2.0",
+    "findup-sync": "^5.0.0",
     "loader.js": "4.7.0",
-    "merge-stream": "2.0.0",
     "mocha": "10.2.0",
     "prettier": "3.0.3",
     "qunit": "2.20.0",
     "qunit-dom": "3.0.0",
     "release-it": "16.3.0",
     "sinon": "17.0.1",
-    "striptags": "3.2.0",
+    "tracked-toolbox": "^1.2.3 || ^2.0.0",
     "webpack": "5.89.0"
   },
   "peerDependencies": {
@@ -142,38 +128,10 @@
   "engines": {
     "node": "18.* || >= 20"
   },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  },
-  "changelog": {
-    "labels": {
-      "breaking": ":boom: Breaking Change",
-      "enhancement": "Features",
-      "bug": "Bug Fixes",
-      "documentation": "Documentation",
-      "internal": "Internal"
-    }
-  },
   "ember": {
     "edition": "octane"
   },
-  "release-it": {
-    "plugins": {
-      "@release-it-plugins/lerna-changelog": {
-        "infile": "CHANGELOG.md",
-        "launchEditor": true
-      }
-    },
-    "git": {
-      "tagName": "v${version}"
-    },
-    "github": {
-      "release": true,
-      "tokenRef": "GITHUB_AUTH"
-    }
-  },
   "volta": {
-    "node": "18.19.0",
-    "pnpm": "8.12.1"
+    "extends": "../package.json"
   }
 }