Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract docs into separate app #604

Merged
merged 1 commit into from
Mar 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,9 @@ updates:
interval: daily
time: "02:00"
open-pull-requests-limit: 3
- package-ecosystem: npm
directory: "/docs"
schedule:
interval: daily
time: "02:00"
open-pull-requests-limit: 3
20 changes: 20 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,26 @@ jobs:
run: yarn test:ember
working-directory: test-app

test-docs:
name: "Test Docs"
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: Install Node
uses: actions/setup-node@v2
with:
node-version: 12.x
cache: yarn
- name: Install Dependencies
run: yarn install --frozen-lockfile
- name: Lint
run: yarn lint
working-directory: docs
- name: Run Tests
run: yarn test:ember
working-directory: docs

floating:
name: "Floating Dependencies"
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img alt="ember-keyboard logo" src="./test-app/public/ember-keyboard.svg" height=72 /> &nbsp;
<img alt="ember-keyboard logo" src="./docs/public/ember-keyboard.svg" height=72 /> &nbsp;
[![npm version](https://badge.fury.io/js/ember-keyboard.svg)](https://badge.fury.io/js/ember-keyboard)
[![Build Status](https://github.com/adopted-ember-addons/ember-keyboard/actions/workflows/ci.yml/badge.svg)](https://github.com/adopted-ember-addons/ember-keyboard/actions/workflows/ci.yml)

Expand Down
10 changes: 5 additions & 5 deletions addon/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
"keywords": [
"ember-addon"
],
"repository": "https://github.com/adopted-ember-addons/ember-keyboard",
"repository": {
"type": "git",
"url": "https://github.com/adopted-ember-addons/ember-keyboard.git",
"directory": "addon"
},
"license": "MIT",
"author": "",
"directories": {
"doc": "doc",
"test": "tests"
},
"exports": {
".": "./dist/index.js",
"./*": "./dist/*",
Expand Down
19 changes: 19 additions & 0 deletions docs/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org

root = true

[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 2

[*.hbs]
insert_final_newline = false

[*.{diff,md}]
trim_trailing_whitespace = false
9 changes: 9 additions & 0 deletions docs/.ember-cli
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
/**
Ember CLI sends analytics information by default. The data is completely
anonymous, but there are times when you might want to disable this behavior.

Setting `disableAnalytics` to true will prevent any data from being sent.
*/
"disableAnalytics": false
}
23 changes: 23 additions & 0 deletions docs/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# unconventional js
/blueprints/*/files/
/vendor/

# compiled output
/dist/
/tmp/

# dependencies
/bower_components/
/node_modules/

# misc
/coverage/
!.*
.*/
.eslintcache

# ember-try
/.node_modules.ember-try/
/bower.json.ember-try
/package.json.ember-try
/yarn.lock.ember-try
50 changes: 50 additions & 0 deletions docs/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
'use strict';

module.exports = {
root: true,
parser: 'babel-eslint',
parserOptions: {
ecmaVersion: 2018,
sourceType: 'module',
ecmaFeatures: {
legacyDecorators: true,
},
},
plugins: ['ember'],
extends: [
'eslint:recommended',
'plugin:ember/recommended',
'plugin:prettier/recommended',
],
env: {
browser: true,
},
rules: {},
overrides: [
// node files
{
files: [
'./.eslintrc.js',
'./.prettierrc.js',
'./.template-lintrc.js',
'./ember-cli-build.js',
'./testem.js',
'./config/**/*.js',
],
parserOptions: {
sourceType: 'script',
},
env: {
browser: false,
node: true,
},
plugins: ['node'],
extends: ['plugin:node/recommended'],
},
{
// Test files:
files: ['tests/**/*-test.{js,ts}'],
extends: ['plugin:qunit/recommended'],
},
],
};
27 changes: 27 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# See https://help.github.com/ignore-files/ for more about ignoring files.

# compiled output
/dist/
/tmp/

# dependencies
/bower_components/
/node_modules/

# misc
/.env*
/.pnp*
/.sass-cache
/.eslintcache
/connect.lock
/coverage/
/libpeerconnection.log
/npm-debug.log*
/testem.log
/yarn-error.log

# ember-try
/.node_modules.ember-try/
/bower.json.ember-try
/package.json.ember-try
/yarn.lock.ember-try
43 changes: 43 additions & 0 deletions docs/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# compiled output
/dist/
/tmp/

# dependencies
/bower_components/

# misc
/.bowerrc
/.editorconfig
/.ember-cli
/.env*
/.eslintcache
/.eslintignore
/.eslintrc.js
/.git/
/.github/
/.gitignore
/.prettierignore
/.prettierrc.js
/.template-lintrc.js
/.watchmanconfig
/bower.json
/config/ember-try.js
/CONTRIBUTING.md
/ember-cli-build.js
/testem.js
/tests/
/yarn-error.log
/yarn.lock
.gitkeep

# ember-try
/.node_modules.ember-try/
/bower.json.ember-try
/package.json.ember-try
/yarn.lock.ember-try

# custom
/.codeclimate.yml
/jsconfig.json
/API-DESIGN.md
/RELEASE.md
25 changes: 25 additions & 0 deletions docs/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# unconventional js
/blueprints/*/files/
/vendor/

# compiled output
/dist/
/tmp/

# dependencies
/bower_components/
/node_modules/

# misc
/coverage/
!.*
.eslintcache
.lint-todo/

# ember-try
/.node_modules.ember-try/
/bower.json.ember-try
/npm-shrinkwrap.json.ember-try
/package.json.ember-try
/package-lock.json.ember-try
/yarn.lock.ember-try
5 changes: 5 additions & 0 deletions docs/.prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
'use strict';

module.exports = {
singleQuote: true,
};
5 changes: 5 additions & 0 deletions docs/.template-lintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
'use strict';

module.exports = {
extends: 'recommended',
};
3 changes: 3 additions & 0 deletions docs/.watchmanconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"ignore_dirs": ["tmp", "dist"]
}
13 changes: 13 additions & 0 deletions docs/app/app.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import Application from '@ember/application';
import Resolver from 'ember-resolver';
import loadInitializers from 'ember-load-initializers';
import config from 'docs/config/environment';
import './custom-elements/input-in-open-shadow';

export default class App extends Application {
modulePrefix = config.modulePrefix;
podModulePrefix = config.podModulePrefix;
Resolver = Resolver;
}

loadInitializers(App, config.modulePrefix);
50 changes: 50 additions & 0 deletions docs/app/components/key-down-counter.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import Component from '@glimmer/component';
import { keyResponder, onKey } from 'ember-keyboard';
import { tracked } from '@glimmer/tracking';

function makeEventHandler(stepSize = 1) {
return function (_event, ekEvent) {
if (this.stopImmediatePropagation) {
ekEvent.stopImmediatePropagation();
}
if (this.stopPropagation) {
ekEvent.stopPropagation();
}
this.counter = this.counter + stepSize;
};
}

@keyResponder
export default class extends Component {
@tracked toggleActivated = true;
@tracked counter = 0;
@tracked keyboardPriority = 0;
@tracked stopPropagation = false;
@tracked stopImmediatePropagation = false;
@tracked keyboardLaxPriority = false;
@tracked keyboardFirstResponder = false;

get keyboardActivated() {
let toggleActivated = this.args.activatedToggle
? this.toggleActivated
: true;
return toggleActivated && this.args.parentActivated;
}

@onKey('ArrowLeft') dec1 = makeEventHandler(-1);
@onKey('ArrowRight') inc1 = makeEventHandler(1);
@onKey('shift+ArrowLeft') dec10 = makeEventHandler(-10);
@onKey('shift+ArrowRight') inc10 = makeEventHandler(10);
@onKey('ctrl+shift+ArrowLeft') dec100 = makeEventHandler(-100);
@onKey('ctrl+shift+ArrowRight') inc100 = makeEventHandler(100);

@onKey('KeyR', { event: 'keyup' })
resetCounter() {
this.counter = 0;
}

@onKey('Digit5', { event: 'keypress' })
resetCounterTo5() {
this.counter = 5;
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable ember/no-classic-components */
/* eslint-disable ember/no-mixins */
import Component from '@ember/component';
import EnterableMixin from 'test-app/mixins/enterable';
import EnterableMixin from 'docs/mixins/enterable';

export default Component.extend(EnterableMixin);
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable ember/no-classic-components */
/* eslint-disable ember/no-mixins */
import Component from '@ember/component';
import EnterableMixin from 'test-app/mixins/enterable';
import EnterableMixin from 'docs/mixins/enterable';

export default Component.extend(EnterableMixin);
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable ember/no-classic-components */
/* eslint-disable ember/no-mixins */
import Component from '@ember/component';
import EnterableMixin from 'test-app/mixins/enterable';
import EnterableMixin from 'docs/mixins/enterable';

export default Component.extend(EnterableMixin);
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable ember/no-classic-components */
/* eslint-disable ember/no-mixins */
import Component from '@ember/component';
import EnterableMixin from 'test-app/mixins/enterable';
import EnterableMixin from 'docs/mixins/enterable';

export default Component.extend(EnterableMixin);
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import Component from '@ember/component';
import { inject as service } from '@ember/service';
import { set } from '@ember/object';
import EnterableMixin from 'test-app/mixins/enterable';
import EnterableMixin from 'docs/mixins/enterable';

export default Component.extend(EnterableMixin, {
keyboard: service(),
Expand Down
Loading