DEV: Add CI setup and fix linting issues (#7)

2022-06-18 16:52:34 +02:00 · 2022-06-18 16:52:34 +02:00 · 02e70aad1c
parent 8ad475a960
commit 02e70aad1c
15 changed files with 2273 additions and 78 deletions
--- a/.eslintrc
+++ b/.eslintrc
@ -0,0 +1,8 @@
+{
+  "extends": "eslint-config-discourse",
+  "ignorePatterns": ["javascripts/vendor/*"],
+  "globals": {
+    "settings": "readonly",
+    "themePrefix": "readonly"
+  }
+}
--- a/.github/workflows/component-linting.yml
+++ b/.github/workflows/component-linting.yml
@ -0,0 +1,48 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  group: plugin-linting-${{ format('{0}-{1}', github.head_ref || github.run_number, github.job) }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: yarn
+
+      - name: Yarn install
+        run: yarn install
+
+      - name: ESLint
+        if: ${{ always() }}
+        run: yarn eslint --ext .js,.js.es6 --no-error-on-unmatched-pattern {test,javascripts}
+
+      - name: Prettier
+        if: ${{ always() }}
+        shell: bash
+        run: |
+          yarn prettier -v
+          files=$(find javascripts desktop mobile common scss -type f \( -name "*.scss" -or -name "*.js" -or -name "*.es6" \) 2> /dev/null) || true
+          if [ -n "$files" ]; then
+            yarn prettier --list-different $files
+          fi
+          if [ 0 -lt $(find test -type f \( -name "*.js" -or -name "*.es6" \) 2> /dev/null | wc -l) ]; then
+            yarn prettier --list-different "test/**/*.{js,es6}"
+          fi
+
+      - name: Ember template lint
+        if: ${{ always() }}
+        run: yarn ember-template-lint --no-error-on-unmatched-pattern javascripts
--- a/.github/workflows/component-tests.yml
+++ b/.github/workflows/component-tests.yml
@ -0,0 +1,147 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  group: plugin-tests-${{ format('{0}-{1}', github.head_ref || github.run_number, github.job) }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    outputs:
+      tests_exist: ${{ steps.check_tests.outputs.tests_exist }}
+
+    steps:
+      - name: Install component
+        uses: actions/checkout@v3
+        with:
+          path: tmp/component
+          fetch-depth: 1
+
+      - name: Check QUnit existence
+        id: check_tests
+        shell: bash
+        run: |
+          if [ 0 -lt $(find tmp/component/test -type f \( -name "*.js" -or -name "*.es6" \) 2> /dev/null | wc -l) ]; then
+            echo "::set-output name=tests_exist::true"
+          fi
+
+  test:
+    needs: check
+    if: ${{ needs.check.outputs.tests_exist }}
+    runs-on: ubuntu-latest
+    container: discourse/discourse_test:slim-browsers
+    timeout-minutes: 15
+
+    env:
+      DISCOURSE_HOSTNAME: www.example.com
+      RUBY_GLOBAL_METHOD_CACHE_SIZE: 131072
+      RAILS_ENV: development
+      PGUSER: discourse
+      PGPASSWORD: discourse
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: discourse/discourse
+          fetch-depth: 1
+
+      - name: Install component
+        uses: actions/checkout@v3
+        with:
+          path: tmp/component
+          fetch-depth: 1
+
+      - name: Setup Git
+        run: |
+          git config --global user.email "ci@ci.invalid"
+          git config --global user.name "Discourse CI"
+
+      - name: Start redis
+        run: |
+          redis-server /etc/redis/redis.conf &
+
+      - name: Start Postgres
+        run: |
+          chown -R postgres /var/run/postgresql
+          sudo -E -u postgres script/start_test_db.rb
+          sudo -u postgres psql -c "CREATE ROLE $PGUSER LOGIN SUPERUSER PASSWORD '$PGPASSWORD';"
+
+      - name: Bundler cache
+        uses: actions/cache@v3
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gem-
+
+      - name: Setup gems
+        run: |
+          gem install bundler --conservative -v $(awk '/BUNDLED WITH/ { getline; gsub(/ /,""); print $0 }' Gemfile.lock)
+          bundle config --local path vendor/bundle
+          bundle config --local deployment true
+          bundle config --local without development
+          bundle install --jobs 4
+          bundle clean
+
+      - name: Lint English locale
+        run: bundle exec ruby script/i18n_lint.rb "tmp/component/locales/en.yml"
+
+      - name: Get yarn cache directory
+        id: yarn-cache-dir
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - name: Yarn cache
+        uses: actions/cache@v3
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Yarn install
+        run: yarn install
+
+      - name: Fetch app state cache
+        uses: actions/cache@v3
+        id: app-cache
+        with:
+          path: tmp/app-cache
+          key: >-
+            ${{ hashFiles('.github/workflows/tests.yml') }}-
+            ${{ hashFiles('db/**/*', 'plugins/**/db/**/*') }}-
+
+      - name: Restore database from cache
+        if: steps.app-cache.outputs.cache-hit == 'true'
+        run: psql -f tmp/app-cache/cache.sql postgres
+
+      - name: Restore uploads from cache
+        if: steps.app-cache.outputs.cache-hit == 'true'
+        run: rm -rf public/uploads && cp -r tmp/app-cache/uploads public/uploads
+
+      - name: Create and migrate database
+        if: steps.app-cache.outputs.cache-hit != 'true'
+        run: |
+          bin/rake db:create
+          bin/rake db:migrate
+
+      - name: Dump database for cache
+        if: steps.app-cache.outputs.cache-hit != 'true'
+        run: mkdir -p tmp/app-cache && pg_dumpall > tmp/app-cache/cache.sql
+
+      - name: Dump uploads for cache
+        if: steps.app-cache.outputs.cache-hit != 'true'
+        run: rm -rf tmp/app-cache/uploads && cp -r public/uploads tmp/app-cache/uploads
+
+      - name: Component QUnit
+        run: |
+          THEME_NAME=$(ruby -e 'require "json"; puts JSON.parse(File.read("tmp/component/about.json"))["name"]')
+          bundle exec rake themes:install -- "--{\"$THEME_NAME\": \"tmp/component\"}"
+          UNICORN_TIMEOUT=120 bundle exec rake "themes:qunit[name,$THEME_NAME]"
+        timeout-minutes: 10
--- a/.gitignore
+++ b/.gitignore
@ -1,2 +1,2 @@
+node_modules
 .discourse-site
-HELP
--- a/.prettierrc
+++ b/.prettierrc
@ -0,0 +1 @@
+{}
--- a/.template-lintrc.js
+++ b/.template-lintrc.js
@ -0,0 +1,4 @@
+module.exports = {
+  plugins: ["ember-template-lint-plugin-discourse"],
+  extends: "discourse:recommended",
+};
--- a/21
+++ b/21
@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Discourse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
--- a/about.json
+++ b/about.json
@ -1,14 +1,12 @@
 {
  "name": "User Card Directory",
+  "component": true,
  "about_url": "https://meta.discourse.org/t/user-card-directory/144479",
  "license_url": null,
  "authors": "David Taylor",
  "minimum_discourse_version": "2.5.0.beta2",
-  "assets": {
-  },
-  "color_schemes": {
-  },
-  "component": true,
+  "assets": {},
+  "color_schemes": {},
  "modifiers": {
    "svg_icons": ["id-card", "th-list"]
  }
--- a/javascripts/discourse/components/user-card-static.js.es6
+++ b/javascripts/discourse/components/user-card-static.js.es6
@ -7,5 +7,5 @@ export default UserCardContents.extend({
  cleanUp() {},
  didInsertElement() {},
  willDestroyElement() {},
-  keyUp() {}
+  keyUp() {},
 });
--- a/javascripts/discourse/initializers/user-card-directory.js.es6
+++ b/javascripts/discourse/initializers/user-card-directory.js.es6
@ -6,10 +6,10 @@ import { ajax } from "discourse/lib/ajax";

 export default {
  name: "user-card-directory",
-  initialize(container) {
+  initialize() {
    withPluginApi("0.8.7", (api) => {
      api.modifyClass("route:users", {
-        pluginId: 'user-card-directory',
+        pluginId: "user-card-directory",
        resetController(controller, isExiting) {
          this._super(...arguments);
          if (isExiting) {
@ -47,7 +47,7 @@ export default {
      });

      api.modifyClass("controller:users", {
-        pluginId: 'user-card-directory',
+        pluginId: "user-card-directory",
        cachedUserCardInfo: null,

        init() {
@ -57,22 +57,23 @@ export default {

        @discourseComputed("model.content.@each")
        userCards(allUsers) {
-          if (!allUsers) return [];
+          if (!allUsers) {
+            return [];
+          }
          const toLoad = [];
          if (settings.hide_current_user && this.currentUser) {
            allUsers = allUsers.filter((u) => u.id !== this.currentUser.id);
          }
-          const userCardInfos = allUsers.map(u => {
+          const userCardInfos = allUsers.map((u) => {
            if (this.cachedUserCardInfo[u.id]) {
              return this.cachedUserCardInfo[u.id];
            }

-            const userCardInfo = (this.cachedUserCardInfo[
-              u.id
-            ] = EmberObject.create({
+            const userCardInfo = (this.cachedUserCardInfo[u.id] =
+              EmberObject.create({
                user: User.create(u.user),
                directoryItem: u,
-              loading: true
+                loading: true,
              }));

            toLoad.push(userCardInfo);
@ -85,17 +86,17 @@ export default {
          while (toLoad.length > 0) {
            const thisBatch = toLoad.splice(0, loadMax);
            const promise = ajax("/user-cards.json", {
-              data: { user_ids: thisBatch.map(uc => uc.user.id).join(",") }
+              data: { user_ids: thisBatch.map((uc) => uc.user.id).join(",") },
            });
-            thisBatch.forEach(uc => {
+            thisBatch.forEach((uc) => {
              // Each user card expects its own promise
              // Rather than making a separate AJAX request for each
              // We re-use the `user-cards.json` promise, and manipulate the data
-              const convertedPromise = promise.then(data => {
+              const convertedPromise = promise.then((data) => {
                // Find the correct user from users, and put it in the user attribute
                // Use Object.assign to avoid contaminating the source object
                return Object.assign({}, data, {
-                  user: data.users.find(u => u.id === uc.user.id)
+                  user: data.users.find((u) => u.id === uc.user.id),
                });
              });
              return uc.user
@ -105,8 +106,8 @@ export default {
          }

          return userCardInfos;
-        }
+        },
      });
    });
-  }
+  },
 };
--- a/javascripts/discourse/templates/users-as-card-directory.hbs
+++ b/javascripts/discourse/templates/users-as-card-directory.hbs
@ -1,11 +1,22 @@
 {{#d-section pageClass="users"}}
-  {{#load-more selector=".user-card-directory .user-card-container" action=(action "loadMore")}}
+  {{#load-more
+    selector=".user-card-directory .user-card-container"
+    action=(action "loadMore")
+  }}
    <div class="container">
      <div class="users-directory directory">
-        {{plugin-outlet name="users-top" connectorTagName="div" args=(hash model=model)}}
+        {{plugin-outlet
+          name="users-top"
+          connectorTagName="div"
+          args=(hash model=model)
+        }}
        <div class="directory-controls">
          <div class="period-controls">
-            {{period-chooser period=period onChange=(action (mut period)) fullDay=false}}
+            {{period-chooser
+              period=period
+              onChange=(action (mut period))
+              fullDay=false
+            }}
            {{#if lastUpdatedAt}}
              <div class="directory-last-updated">
                {{i18n "directory.last_updated"}}
@ -31,9 +42,7 @@
                value=group
                content=groupOptions
                onChange=(action groupChanged)
-                options=(hash
-                  none="directory.group.all"
-                )
+                options=(hash none="directory.group.all")
              }}
            {{/if}}
            {{#if currentUser.staff}}
@ -43,7 +52,12 @@
                class="btn-default open-edit-columns-btn"
              }}
            {{/if}}
-            {{plugin-outlet name="users-directory-controls" connectorTagName="" tagName="" args=(hash model=model)}}
+            {{plugin-outlet
+              name="users-directory-controls"
+              connectorTagName=""
+              tagName=""
+              args=(hash model=model)
+            }}
          </div>
        </div>

@ -58,15 +72,23 @@
                    loading=userCard.loading
                    username=userCard.user.username
                  }}
-                {{#if (theme-setting 'show_stats')}}
-                <div class='user-card-directory-footer'>
+                  {{#if (theme-setting "show_stats")}}
+                    <div class="user-card-directory-footer">
                      {{#each columns as |column|}}
                        <span class="stat stat-{{stat.name}}">
                          <span class="value">
-                        {{#if (directory-column-is-user-field column=column)}}
-                          {{directory-item-user-field-value item=userCard.directoryItem column=column}}
+                            {{#if
+                              (directory-column-is-user-field column=column)
+                            }}
+                              {{directory-item-user-field-value
+                                item=userCard.directoryItem
+                                column=column
+                              }}
                            {{else}}
-                          {{directory-item-value item=userCard.directoryItem column=column}}
+                              {{directory-item-value
+                                item=userCard.directoryItem
+                                column=column
+                              }}
                            {{/if}}
                          </span>
                          <span class="label">
@ -75,7 +97,9 @@
                              icon=column.icon
                              order=order
                              asc=asc
-                          automatic=(directory-column-is-automatic column=column)
+                              automatic=(directory-column-is-automatic
+                                column=column
+                              )
                              translated=column.user_field_id
                              onActiveRender=setActiveHeader
                            }}
--- a/package.json
+++ b/package.json
@ -0,0 +1,10 @@
+{
+  "name": "discourse-user-card-directory",
+  "version": "1.0.0",
+  "repository": "https://github.com/discourse/discourse-user-card-directory",
+  "author": "Discourse",
+  "license": "MIT",
+  "devDependencies": {
+    "eslint-config-discourse": "^3.2.0"
+  }
+}
--- a/test/acceptance/users-test.js
+++ b/test/acceptance/users-test.js
@ -1,8 +1,4 @@
-import {
-  acceptance,
-  exists,
-  count,
-} from "discourse/tests/helpers/qunit-helpers";
+import { acceptance, count } from "discourse/tests/helpers/qunit-helpers";
 import { test } from "qunit";
 import { click, visit } from "@ember/test-helpers";

--- a/yarn.lock
+++ b/yarn.lock