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

This commit is contained in:
Jarek Radosz 2022-06-18 21:27:31 +02:00 committed by GitHub
parent c9dde66727
commit 1c4f5b1a99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 1848 additions and 732 deletions

View File

@ -1,6 +1,8 @@
{ {
"extends": "eslint-config-discourse", "extends": "eslint-config-discourse",
"ignorePatterns": ["javascripts/vendor/*"],
"globals": { "globals": {
"themePrefix": "on" "settings": "readonly",
"themePrefix": "readonly"
} }
} }

48
.github/workflows/component-linting.yml vendored Normal file
View File

@ -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

147
.github/workflows/component-tests.yml vendored Normal file
View File

@ -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

3
.gitignore vendored
View File

@ -1,3 +1,2 @@
.discourse-site
HELP
node_modules node_modules
.discourse-site

1
.prettierrc Normal file
View File

@ -0,0 +1 @@
{}

4
.template-lintrc.js Normal file
View File

@ -0,0 +1,4 @@
module.exports = {
plugins: ["ember-template-lint-plugin-discourse"],
extends: "discourse:recommended",
};

View File

@ -1,6 +1,6 @@
{ {
"name": "discourse-placeholder-theme-component", "name": "discourse-placeholder-theme-component",
"component": true,
"about_url": "https://github.com/discourse/discourse-placeholder-theme-component", "about_url": "https://github.com/discourse/discourse-placeholder-theme-component",
"license_url": "https://github.com/discourse/discourse-placeholder-theme-component/blob/main/LICENSE", "license_url": "https://github.com/discourse/discourse-placeholder-theme-component/blob/main/LICENSE"
"component": true
} }

View File

@ -2,6 +2,8 @@ import Controller from "@ember/controller";
import ModalFunctionality from "discourse/mixins/modal-functionality"; import ModalFunctionality from "discourse/mixins/modal-functionality";
import EmberObject, { action } from "@ember/object"; import EmberObject, { action } from "@ember/object";
import { isBlank } from "@ember/utils"; import { isBlank } from "@ember/utils";
import I18n from "I18n";
import bootbox from "bootbox";
export default Controller.extend(ModalFunctionality, { export default Controller.extend(ModalFunctionality, {
form: null, form: null,

View File

@ -1,6 +1,6 @@
import showModal from "discourse/lib/show-modal"; import showModal from "discourse/lib/show-modal";
import { withPluginApi } from "discourse/lib/plugin-api"; import { withPluginApi } from "discourse/lib/plugin-api";
import { later, debounce } from "@ember/runloop"; import { debounce, later } from "@ember/runloop";
import cookie, { removeCookie } from "discourse/lib/cookie"; import cookie, { removeCookie } from "discourse/lib/cookie";
const VALID_TAGS = const VALID_TAGS =
@ -112,7 +112,7 @@ export default {
key: `${STORAGE_PREFIX}${key}`, key: `${STORAGE_PREFIX}${key}`,
value: { value: {
expires: Date.now() + EXPIRE_AFTER_SECONDS, expires: Date.now() + EXPIRE_AFTER_SECONDS,
value: value, value,
}, },
}); });
}, },
@ -130,7 +130,9 @@ export default {
withPluginApi("0.8.7", (api) => { withPluginApi("0.8.7", (api) => {
api.decorateCookedElement( api.decorateCookedElement(
(cooked, postWidget) => { (cooked, postWidget) => {
if (!postWidget) return; if (!postWidget) {
return;
}
const postIdentifier = `${postWidget.widget.attrs.topicId}-${postWidget.widget.attrs.id}-`; const postIdentifier = `${postWidget.widget.attrs.topicId}-${postWidget.widget.attrs.id}-`;
const mappings = []; const mappings = [];
@ -160,7 +162,9 @@ export default {
cooked.querySelectorAll(VALID_TAGS).forEach((elem, index) => { cooked.querySelectorAll(VALID_TAGS).forEach((elem, index) => {
const mapping = mappings[index]; const mapping = mappings[index];
if (!mapping) return; if (!mapping) {
return;
}
let diff = 0; let diff = 0;
let replaced = false; let replaced = false;
@ -190,7 +194,9 @@ export default {
diff = diff + newValue.length - previousLength; diff = diff + newValue.length - previousLength;
}); });
if (replaced) elem.innerHTML = newInnnerHTML; if (replaced) {
elem.innerHTML = newInnnerHTML;
}
}); });
}; };
@ -252,7 +258,9 @@ export default {
placeholderNodes.forEach((elem) => { placeholderNodes.forEach((elem) => {
const dataKey = elem.dataset.key; const dataKey = elem.dataset.key;
if (!dataKey) return; if (!dataKey) {
return;
}
const placeholderIdentifier = `${postIdentifier}${dataKey}`; const placeholderIdentifier = `${postIdentifier}${dataKey}`;
const valueFromStore = this.getValue(placeholderIdentifier); const valueFromStore = this.getValue(placeholderIdentifier);

View File

@ -1,7 +1,8 @@
{{#d-modal-body {{#d-modal-body
title=(theme-prefix "builder.title") title=(theme-prefix "builder.title")
class="discourse-placeholder-builder" class="discourse-placeholder-builder"
style="overflow: auto"}} style="overflow: auto"
}}
<form> <form>
<div class="control"> <div class="control">
<span class="label"> <span class="label">
@ -26,7 +27,11 @@
input=(action (mut form.description) value="target.value") input=(action (mut form.description) value="target.value")
}} }}
</div> </div>
<p class="description">{{theme-i18n "builder.description.description"}}</p> <p class="description">
{{theme-i18n
"builder.description.description"
}}
</p>
</div> </div>
<div class="control"> <div class="control">
@ -39,10 +44,7 @@
nameProperty=null nameProperty=null
value=form.values value=form.values
content=form.values content=form.values
options=(hash options=(hash allowAny=true placementStrategy="absolute")
allowAny=true
placementStrategy="absolute"
)
onChange=(action (mut form.values)) onChange=(action (mut form.values))
}} }}
</div> </div>

View File

@ -1,10 +1,10 @@
{ {
"name": "discourse-placeholder-theme-component", "name": "discourse-placeholder-theme-component",
"version": "1.0.0", "version": "1.0.0",
"repository": "git@github.com:discourse/discourse-placeholder-theme-component.git", "repository": "https://github.com/discourse/discourse-placeholder-theme-component",
"author": "Discourse", "author": "Discourse",
"license": "MIT", "license": "MIT",
"devDependencies": { "devDependencies": {
"eslint-config-discourse": "1.1.0" "eslint-config-discourse": "^3.2.0"
} }
} }

2329
yarn.lock

File diff suppressed because it is too large Load Diff