Merge remote-tracking branch 'origin/master' into glint

As a bonus, actually set the npm version in the Volta config so users
who are using it will get the right npm version automatically and not
trip over a lockfile version mismatch in CI.

Author: chriskrycho

.github/workflows/ci.yml

@@ -7,76 +7,59 @@ on:
   pull_request:
 
 env:
-  NODE_VERSION: 12
+  NODE_VERSION: 14
   PERCY_PARALLEL_NONCE: ${{ github.run_id }}-${{ github.run_number }}
   PERCY_PARALLEL_TOTAL: 1
 
 jobs:
   lint:
     name: Lint files
     runs-on: ubuntu-latest
-    timeout-minutes: 3
+    timeout-minutes: 5
     steps:
       - name: Check out a copy of the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - name: Use Node.js 14
-        uses: volta-cli/action@v4
+      - name: Check lockfile version
+        uses: mansona/npm-lockfile-version@v1
 
-      - name: Get Yarn cache path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Cache Yarn cache and node_modules
-        id: cache-dependencies
-        uses: actions/cache@v2
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v3
         with:
-          path: |
-            ${{ steps.yarn-cache-dir-path.outputs.dir }}
-            node_modules
-          key: ${{ runner.os }}-${{ env.NODE_VERSION }}-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: ${{ runner.os }}-${{ env.NODE_VERSION }}-
+          cache: 'npm'
+          node-version: ${{ env.NODE_VERSION }}
+
+      - run: npm i -g npm@9
 
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
-        if: steps.cache-dependencies.outputs.cache-hit != 'true'
+        run: npm ci
 
       - name: Lint
-        run: yarn lint
+        run: npm run lint
 
 
   test-app:
     name: Test app
     runs-on: ubuntu-latest
-    timeout-minutes: 7
+    timeout-minutes: 10
     steps:
       - name: Check out a copy of the repo
-        uses: actions/checkout@v2
-
-      - name: Use Node.js 14
-        uses: volta-cli/action@v4
+        uses: actions/checkout@v3
 
-      - name: Get Yarn cache path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - name: Cache Yarn cache and node_modules
-        id: cache-dependencies
-        uses: actions/cache@v2
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v3
         with:
-          path: |
-            ${{ steps.yarn-cache-dir-path.outputs.dir }}
-            node_modules
-          key: ${{ runner.os }}-14-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: ${{ runner.os }}-14-
+          cache: 'npm'
+          node-version: ${{ env.NODE_VERSION }}
+
+      - run: npm i -g npm@9
 
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
-        if: steps.cache-dependencies.outputs.cache-hit != 'true'
+        run: npm ci
 
       - name: Test
         env:
           PERCY_PARALLEL_NONCE: ${{ env.PERCY_PARALLEL_NONCE }}
           PERCY_PARALLEL_TOTAL: ${{ env.PERCY_PARALLEL_TOTAL }}
           PERCY_TOKEN: 5ad6687f6b1ad3dec2b964f94d3d59ff3880baccf1492c0663e85c1ce79c1a52
-        run: yarn run percy exec -- yarn test:ember
+        run: npx percy exec -- npm run test:ember

.gitignore

@@ -27,7 +27,6 @@ terraform.tfstate.backup
 /libpeerconnection.log
 /npm-debug.log*
 /testem.log
-/yarn-error.log
 
 public/json-docs/
 public/rev-index/

CONTRIBUTING.md

@@ -77,20 +77,20 @@ clone the latest ember.js api docs from github
 cd to the cloned ember-api-docs directory
  - cd ember-api-docs
 
-ensure Node.js and yarn are installed
+ensure Node.js and npm are installed
 
 follow these commands to build ember.js
- - yarn install
- - yarn run build
+ - npm install
+ - npm build
 ```
 
 ## Development steps
 
 1. Follow the setup steps listed above under [Building Ember.js API](#building-emberjs-api-docs).
 
-2. To start the development server, run `yarn start`.
+2. To start the development server, run `npm start`.
 
-3. To run all tests run `yarn test`
+3. To run all tests run `npm test`
 
 4. To run the app with fastboot cli like our server deployment run the following commands,
 ```
@@ -106,7 +106,7 @@ We love pull requests. Here's a quick guide:
 1. Fork the repo.
 
 2. Run the tests. We only take pull requests with passing tests, and it's great
-to know that you have a clean slate: `yarn install && yarn test`.
+to know that you have a clean slate: `npm install && npm test`.
 
 3. Add a test for your change. Only refactoring and documentation changes
 require no new tests. If you are adding functionality or fixing a bug, we need

README.md

@@ -42,7 +42,7 @@ locally yourself.
 ```
 git clone https://github.com/ember-learn/ember-api-docs.git
 cd ember-api-docs
-yarn install
+npm install
 ember serve
 ```
 View at http://localhost:4200
@@ -53,9 +53,9 @@ To run a11y tests, run `test_a11y=yes ember serve`
 
 ## Linting
 
-* `yarn run lint:hbs`
-* `yarn run lint:js`
-* `yarn run lint:js -- --fix`
+* `npm run lint:hbs`
+* `npm run lint:js`
+* `npm run lint:js -- --fix`
 
 ## Staging and Deployment
 

app/controllers/project-version/classes/class.js

@@ -1,23 +1,60 @@
 /* eslint-disable ember/no-computed-properties-in-native-classes, ember/classic-decorator-no-classic-methods */
-import { action, computed } from '@ember/object';
+import { action, computed, set, get } from '@ember/object';
 import { inject as service } from '@ember/service';
 import Controller from '@ember/controller';
-import ParentNameMixin from 'ember-api-docs/mixins/parent-name';
-import FilterParams from 'ember-api-docs/mixins/filter-params';
+import { A } from '@ember/array';
+import { capitalize } from '@ember/string';
+import { isEmpty } from '@ember/utils';
+import { parentName } from '../../../utils/parent-name';
+
+const filterTypes = ['inherited', 'protected', 'private', 'deprecated'];
+const DEFAULT_FILTER = 'inherited';
+
+export default class ClassController extends Controller {
+  /** @type {import('@ember/routing/router-service').default} */
+  @service
+  router;
 
-export default class ClassController extends Controller.extend(
-  ParentNameMixin,
-  FilterParams
-) {
   @service
   filterData;
 
+  queryParams = [{ visibilityFilter: 'show' }];
+
   @service
   legacyModuleMappings;
 
   @service
   metaStore;
 
+  @computed(
+    'filterData.{showInherited,showProtected,showPrivate,showDeprecated}'
+  )
+  get visibilityFilter() {
+    let appliedFilters = filterTypes
+      .reduce((filters, filter) => {
+        let filterValue = get(this, `filterData.show${capitalize(filter)}`)
+          ? filter
+          : null;
+        filters.push(filterValue);
+        return filters;
+      }, A())
+      .compact();
+
+    if (isEmpty(appliedFilters)) {
+      return DEFAULT_FILTER;
+    } else {
+      return appliedFilters.join(',');
+    }
+  }
+
+  set visibilityFilter(value = '') {
+    let filters = A(value.split(','));
+    filterTypes.forEach((filter) => {
+      let enabled = filters.indexOf(filter) > -1;
+      set(this, `filterData.show${capitalize(filter)}`, enabled);
+    });
+  }
+
   @computed('legacyModuleMappings.mappings', 'model.{module,name}')
   get hasImportExample() {
     return this.legacyModuleMappings.hasClassMapping(
@@ -41,6 +78,10 @@ export default class ClassController extends Controller.extend(
     ];
   }
 
+  get parentName() {
+    return parentName(this.router.currentRouteName);
+  }
+
   @action
   updateFilter(filter) {
     this.toggleProperty(`filterData.${filter}`);

app/controllers/project-version/classes/class/index.js

@@ -1,10 +1,16 @@
 import { inject as service } from '@ember/service';
 import Controller from '@ember/controller';
-import ParentNameMixin from 'ember-api-docs/mixins/parent-name';
+import { parentName } from '../../../../utils/parent-name';
 
-export default class IndexController extends Controller.extend(
-  ParentNameMixin
-) {
+export default class IndexController extends Controller {
   @service
   filterData;
+
+  /** @type {import('@ember/routing/router-service').default} */
+  @service
+  router;
+
+  get parentName() {
+    return parentName(this.router.currentRouteName);
+  }
 }

app/mixins/filter-params.js

@@ -2,6 +2,10 @@ import { inject as service } from '@ember/service';
 import Route from '@ember/routing/route';
 
 export default class ClassRoute extends Route {
+  /** @type {import('@ember/routing/router-service').default} */
+  @service
+  router;
+
   @service
   legacyModuleMappings;
 
@@ -29,14 +33,14 @@ export default class ClassRoute extends Route {
     if (!mappedInfo.error && model.className !== mappedInfo.newName) {
       let { itemType, newName, newModule } = mappedInfo;
       if (itemType === 'class') {
-        return this.transitionTo(
+        return this.router.transitionTo(
           `project-version.classes.class`,
           'ember',
           'release',
           newName
         );
       } else {
-        return this.transitionTo(
+        return this.router.transitionTo(
           `project-version.functions.function`,
           'ember',
           'release',
@@ -45,6 +49,6 @@ export default class ClassRoute extends Route {
         );
       }
     }
-    return this.transitionTo('project-version', 'ember', 'release');
+    return this.router.transitionTo('project-version', 'ember', 'release');
   }
 }