Skip to content

Commit ac0be85

Browse files
christianalfonichristianalfoni
committed
docs(overmind): monorepo markdown
2 parents 4814c56 + 8785901 commit ac0be85

File tree

374 files changed

+38997
-32733
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

374 files changed

+38997
-32733
lines changed

‎.cz-config.js‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
'use strict'
2+
3+
module.exports = {
4+
types: [
5+
{ value: 'feat', name: 'feat: A new feature' },
6+
{ value: 'fix', name: 'fix: A bug fix' },
7+
{ value: 'docs', name: 'docs: Documentation only changes' },
8+
{
9+
value: 'style',
10+
name:
11+
'style: Changes that do not affect the meaning of the code\n (white-space, formatting, missing semi-colons, etc)',
12+
},
13+
{
14+
value: 'refactor',
15+
name:
16+
'refactor: A code change that neither fixes a bug nor adds a feature',
17+
},
18+
{
19+
value: 'perf',
20+
name: 'perf: A code change that improves performance',
21+
},
22+
{ value: 'test', name: 'test: Adding missing tests' },
23+
{
24+
value: 'chore',
25+
name:
26+
'chore: Changes to the build process or auxiliary tools\n and libraries such as documentation generation',
27+
},
28+
{ value: 'revert', name: 'revert: Revert to a commit' },
29+
],
30+
31+
scopes: [
32+
{ name: 'website' },
33+
{ name: 'overmind' },
34+
{ name: 'overmind-devtools' },
35+
{ name: 'overmind-react' },
36+
{ name: 'overmind-vue' },
37+
{ name: 'overmind-angular' },
38+
{ name: 'action-chain' },
39+
{ name: 'proxy-state-tree' },
40+
{ name: 'betsy' },
41+
],
42+
43+
// it needs to match the value for field type. Eg.: 'fix'
44+
scopeOverrides: {
45+
chore: [],
46+
},
47+
48+
allowCustomScopes: true,
49+
allowBreakingChanges: ['feat', 'fix'],
50+
appendBranchNameToCommitMessage: false,
51+
}

‎.eslintrc.json‎

Lines changed: 41 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
11
{
2-
"parserOptions": {
3-
"ecmaVersion": 2017,
4-
"sourceType": "module",
5-
"ecmaFeatures": {
6-
"jsx": true
7-
}
8-
},
9-
"env": {
10-
"browser": true,
11-
"node": true,
12-
"es6": true
13-
},
14-
"extends": [ "standard", "standard-jsx", "plugin:prettier/recommended", "prettier/react", "prettier/standard" ],
15-
"rules": {
16-
"linebreak-style": [ "error", "unix" ]
17-
},
18-
"overrides": [
19-
{
20-
"files": [ "*.ts" ],
21-
"parser": "typescript-eslint-parser",
22-
"plugins": [ "typescript" ],
23-
"rules": {
24-
"import/export": "off",
25-
"no-dupe-class-members": "off",
26-
"no-empty-pattern": "off",
27-
"no-redeclare": "off",
28-
"no-unused-vars": "off",
29-
"no-undef": "off",
30-
"no-unused-expressions": "off",
31-
"no-use-before-define": "off",
32-
"no-useless-constructor": "off",
33-
"typescript/no-unused-vars": "error"
34-
}
35-
}
36-
]
2+
"parserOptions": {
3+
"ecmaVersion": 2017,
4+
"sourceType": "module",
5+
"ecmaFeatures": {
6+
"jsx": true
7+
}
8+
},
9+
"env": {
10+
"browser": true,
11+
"node": true,
12+
"es6": true
13+
},
14+
"extends": [
15+
"standard",
16+
"standard-jsx",
17+
"plugin:prettier/recommended",
18+
"prettier/react",
19+
"prettier/standard"
20+
],
21+
"rules": {
22+
"linebreak-style": ["error", "unix"]
23+
},
24+
"overrides": [
25+
{
26+
"files": ["*.ts", "*.tsx"],
27+
"parser": "typescript-eslint-parser",
28+
"plugins": ["typescript"],
29+
"rules": {
30+
"import/export": "off",
31+
"no-dupe-class-members": "off",
32+
"no-empty-pattern": "off",
33+
"no-redeclare": "off",
34+
"no-unused-vars": "off",
35+
"no-undef": "off",
36+
"no-unused-expressions": "off",
37+
"no-use-before-define": "off",
38+
"no-useless-constructor": "off",
39+
"typescript/no-unused-vars": "error"
40+
}
41+
}
42+
]
3743
}

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/packages/node_modules/** linguist-generated=false linguist-vendored=false
2+
* text=auto

‎.gitignore‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Logs
2+
.idea
23
logs
34
*.log
45
npm-debug.log*
@@ -39,8 +40,14 @@ bower_components
3940
build/Release
4041

4142
# Dependency directories
42-
node_modules/
43-
jspm_packages/
43+
node_modules
44+
!/packages/node_modules
45+
/packages/node_modules/**/node_modules
46+
jspm_packages
47+
48+
# Lock files
49+
yarn.lock
50+
/packages/**/package-lock.json
4451

4552
# TypeScript v1 declaration files
4653
typings/
@@ -61,7 +68,7 @@ typings/
6168
.yarn-integrity
6269

6370
# dotenv environment variables file
64-
.env
71+
.env*
6572

6673
# next.js build output
6774
.next

‎.prettierrc.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
2-
"trailingComma": "es5",
3-
"singleQuote": true,
4-
"semi": false,
5-
"arrowParens": "always",
6-
"overrides": [
7-
{
8-
"files": "*.md",
9-
"options": {
10-
"trailingComma": "none"
11-
}
12-
}
13-
]
2+
"trailingComma": "es5",
3+
"singleQuote": true,
4+
"semi": false,
5+
"arrowParens": "always",
6+
"overrides": [
7+
{
8+
"files": "*.md",
9+
"options": {
10+
"trailingComma": "none"
11+
}
12+
}
13+
]
1414
}

‎.travis.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
sudo: false
2+
language: node_js
3+
node_js: '8'
4+
install:
5+
- npm ci
6+
cache:
7+
directories:
8+
- '$HOME/.npm'
9+
addons:
10+
apt:
11+
sources:
12+
- ubuntu-toolchain-r-test
13+
packages:
14+
# needed by nodegit (repo-cooker)
15+
- libstdc++-4.9-dev
16+
git:
17+
depth: 9999
18+
notifications:
19+
email: false
20+
before_install: dpkg --compare-versions `npm -v` ge 6.3 || npm i -g npm@^6.3
21+
script:
22+
- |
23+
if [[ $SKIP_TESTS != 'true' ]]; then
24+
npm prune
25+
npm run checkdeps
26+
npm run lint
27+
npm test
28+
fi
29+
after_success:
30+
- |
31+
if [[ $TRAVIS_SECURE_ENV_VARS == 'true' ]]; then
32+
git config --global user.email "[email protected]";
33+
git config --global user.name "Cerebral JS";
34+
fi
35+
if [[ $TRAVIS_BRANCH == 'master' || $TRAVIS_BRANCH == 'next' ]] && [[ $TRAVIS_PULL_REQUEST == 'false' ]]; then
36+
printf "//registry.npmjs.org/:_authToken=$NPM_TOKEN\n" > ~/.npmrc
37+
npm install --no-save [email protected] now
38+
npm run release
39+
fi
40+
if [[ $TRAVIS_BRANCH == 'master' ]] && [[ $TRAVIS_PULL_REQUEST == 'false' ]]; then
41+
42+
now ./packages/overmind-website -e REDIRECT_URL=https://overmindjs.org/ now-examples/redirect --docker --token $NOW_TOKEN && now alias www.overmindjs.org --token $NOW_TOKEN
43+
fi
44+
if [[ $TRAVIS_BRANCH == 'next' ]] && [[ $TRAVIS_PULL_REQUEST == 'false' ]]; then
45+
now ./packages/overmind-website --docker --token $NOW_TOKEN && now alias next.overmindjs.org --token $NOW_TOKEN
46+
fi
47+
branches:
48+
except:
49+
- "/^v\\d+\\.\\d+\\.\\d+$/"

‎README.md‎

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,3 @@
11
# Overmind
22

3-
4-
5-
### What is it?
6-
7-
Overmind is a tool to build web applications. It allows you to choose your favourite way of expressing UI, while given great insight into your running application using the Overmind development tool.The benefits of Overmind
8-
9-
* **Automatic render.** When you connect your app to a component the component will automatically and optimally rerender based on the state that is being used inside that component
10-
* **Safe mutations**. There is only one place in Overmind you can change the state of your application and that is inside the mutation operator. Any outside mutations throws errors
11-
* **Next level devtools.** The Overmind devtools gives you insight into everything that is happening inside your application. That being what state connected components are watching, actions being run, mutations performed and even side effects run
12-
* **Functional actions.** Instead of expressing logic as functions or methods, Overmind exposes an action chaining API. This forces you into a functional approach. Functional code encourages writing many small and focused functions that does one thing. This keeps your application more testable, maintainable and composable
13-
* **Typescript for the win**. You do not have to use Typescript with Overmind, but when you do you will get full type safety in action chains and components
14-
3+
Visit website for more information: [www.overmindjs.org](https://www.overmindjs.org).

‎SUMMARY.md‎

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1 @@
1-
# Table of contents
2-
3-
* [Overmind](README.md)
4-
* [Get started](get-started.md)
5-
* [Devtools](devtools.md)
6-
* [Side effects](untitled.md)
7-
* [Derived state](derived-state.md)
8-
* [Computed values](computed-values.md)
9-
* [Reactions](reactions.md)
10-
* [Namespacing](namespacing.md)
11-
* [API](api/README.md)
12-
* [app](api/app.md)
13-
* [action](api/action.md)
14-
* [computed](api/computed.md)
15-
* [derived](api/derived.md)
16-
* [namespaces](api/namespaces.md)
17-
* [providers](api/providers.md)
18-
* [reaction](api/reaction.md)
19-
* [state](api/state.md)
20-
1+
# Readme

‎logo.png‎

55.9 KB
Loading

‎logo.psd‎

357 KB
Binary file not shown.

0 commit comments

Comments
 (0)