Skip to content

Commit d809e9b

Browse files
larionovlarionov
authored
Merge pull request #1 from vuejs/master
update
2 parents c82cc10 + c7999cf commit d809e9b

File tree

394 files changed

+14947
-8544
lines changed

Some content is hidden

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

394 files changed

+14947
-8544
lines changed

‎.all-contributorsrc

+159
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
{
2+
"projectName": "VuePress",
3+
"projectOwner": "Ulivz",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 100,
10+
"commit": false,
11+
"commitConvention": "none",
12+
"contributors": [
13+
{
14+
"login": "yyx990803",
15+
"name": "Evan You",
16+
"avatar_url": "https://avatars1.githubusercontent.com/u/499550?v=4",
17+
"profile": "http://evanyou.me",
18+
"contributions": [
19+
"code"
20+
]
21+
},
22+
{
23+
"login": "ulivz",
24+
"name": "ULIVZ",
25+
"avatar_url": "https://avatars1.githubusercontent.com/u/23133919?v=4",
26+
"profile": "http://ulivz.com",
27+
"contributions": [
28+
"code",
29+
"doc"
30+
]
31+
},
32+
{
33+
"login": "jlooper",
34+
"name": "Jen Looper",
35+
"avatar_url": "https://avatars2.githubusercontent.com/u/1450004?v=4",
36+
"profile": "http://www.jenlooper.com",
37+
"contributions": [
38+
"doc",
39+
"design"
40+
]
41+
},
42+
{
43+
"login": "sarahdayan",
44+
"name": "Sarah Dayan",
45+
"avatar_url": "https://avatars0.githubusercontent.com/u/5370675?v=4",
46+
"profile": "https://frontstuff.io/",
47+
"contributions": [
48+
"code",
49+
"doc"
50+
]
51+
},
52+
{
53+
"login": "kefranabg",
54+
"name": "Franck Abgrall",
55+
"avatar_url": "https://avatars3.githubusercontent.com/u/9840435?v=4",
56+
"profile": "https://www.franck-abgrall.me/",
57+
"contributions": [
58+
"code",
59+
"question"
60+
]
61+
},
62+
{
63+
"login": "sobolevn",
64+
"name": "Nikita Sobolev",
65+
"avatar_url": "https://avatars1.githubusercontent.com/u/4660275?v=4",
66+
"profile": "https://sobolevn.me",
67+
"contributions": [
68+
"code",
69+
"doc"
70+
]
71+
},
72+
{
73+
"login": "f3ltron",
74+
"name": "Giraud Florent",
75+
"avatar_url": "https://avatars1.githubusercontent.com/u/11556276?v=4",
76+
"profile": "https://github.com/f3ltron",
77+
"contributions": [
78+
"code"
79+
]
80+
},
81+
{
82+
"login": "CodesOfRa",
83+
"name": "Ramona",
84+
"avatar_url": "https://avatars0.githubusercontent.com/u/945186?v=4",
85+
"profile": "https://twitter.com/CodesOfRa",
86+
"contributions": [
87+
"code"
88+
]
89+
},
90+
{
91+
"login": "fatihacet",
92+
"name": "Fatih Acet",
93+
"avatar_url": "https://avatars3.githubusercontent.com/u/712419?v=4",
94+
"profile": "https://fatihacet.com",
95+
"contributions": [
96+
"code"
97+
]
98+
},
99+
{
100+
"login": "filrak",
101+
"name": "Filip Rakowski",
102+
"avatar_url": "https://avatars2.githubusercontent.com/u/15185752?v=4",
103+
"profile": "https://rakowski.dev",
104+
"contributions": [
105+
"code"
106+
]
107+
},
108+
{
109+
"login": "farcaller",
110+
"name": "Vladimir Pouzanov",
111+
"avatar_url": "https://avatars2.githubusercontent.com/u/693?v=4",
112+
"profile": "http://farcaller.net/",
113+
"contributions": [
114+
"code"
115+
]
116+
},
117+
{
118+
"login": "vicbergquist",
119+
"name": "Victoria Bergquist",
120+
"avatar_url": "https://avatars0.githubusercontent.com/u/25737281?v=4",
121+
"profile": "https://twitter.com/vicbergquist",
122+
"contributions": [
123+
"code",
124+
"design"
125+
]
126+
},
127+
{
128+
"login": "newsbielt703",
129+
"name": "Billyyyyy3320",
130+
"avatar_url": "https://avatars0.githubusercontent.com/u/38957202?v=4",
131+
"profile": "https://billychin.netlify.com/",
132+
"contributions": [
133+
"code"
134+
]
135+
},
136+
{
137+
"login": "bencodezen",
138+
"name": "Ben Hong",
139+
"avatar_url": "https://avatars0.githubusercontent.com/u/4836334?v=4",
140+
"profile": "http://www.bencodezen.io",
141+
"contributions": [
142+
"code",
143+
"blog"
144+
]
145+
},
146+
{
147+
"login": "vinayakkulkarni",
148+
"name": "Vinayak Kulkarni",
149+
"avatar_url": "https://avatars2.githubusercontent.com/u/19776877?v=4",
150+
"profile": "https://twitter.com/_vinayak_k",
151+
"contributions": [
152+
"plugin",
153+
"code",
154+
"blog"
155+
]
156+
},
157+
],
158+
"contributorsPerLine": 7
159+
}

‎.circleci/config.yml

+135
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Javascript Node CircleCI 2.0 configuration file
2+
#
3+
# Check https://circleci.com/docs/2.0/language-javascript/ for more details
4+
#
5+
version: 2.1
6+
7+
defaults: &defaults
8+
working_directory: ~/project
9+
docker:
10+
- image: circleci/node:latest
11+
12+
jobs:
13+
14+
#------------------------------------------------------------
15+
# 1. Install dependencies
16+
#------------------------------------------------------------
17+
18+
install-dependencies:
19+
<<: *defaults
20+
steps:
21+
- checkout
22+
23+
- restore_cache:
24+
keys:
25+
- v1-deps-{{ checksum "yarn.lock" }}
26+
- v1-deps
27+
28+
- run:
29+
name: 'Install dependencies'
30+
command: yarn --frozen-lockfile --non-interactive
31+
32+
- save_cache:
33+
key: v1-deps-{{ checksum "yarn.lock" }}
34+
paths:
35+
- ~/.cache/yarn
36+
37+
- persist_to_workspace:
38+
root: ~/project
39+
paths:
40+
- node_modules
41+
- packages/*/node_modules
42+
- packages/@vuepress/*/node_modules
43+
44+
#------------------------------------------------------------
45+
# 2. Run parallel jobs:
46+
# => lerna-boostrap
47+
# => tsc
48+
# => tests
49+
# => linter
50+
# => docs linter
51+
#------------------------------------------------------------
52+
53+
lerna-bootstrap:
54+
<<: *defaults
55+
steps:
56+
- checkout
57+
- attach_workspace:
58+
at: ~/project
59+
- run:
60+
name: 'Lerna bootstrap'
61+
command: yarn lerna:bootstrap
62+
63+
run-tsc:
64+
<<: *defaults
65+
steps:
66+
- checkout
67+
- attach_workspace:
68+
at: ~/project
69+
- run:
70+
name: 'Run tsc'
71+
command: yarn tsc
72+
- persist_to_workspace:
73+
root: ~/project
74+
paths:
75+
- packages/@vuepress/shared-utils/lib
76+
77+
run-tests:
78+
<<: *defaults
79+
steps:
80+
- checkout
81+
- attach_workspace:
82+
at: ~/project
83+
- run:
84+
name: 'Run tests'
85+
command: yarn test
86+
87+
run-linter-check:
88+
<<: *defaults
89+
steps:
90+
- checkout
91+
- attach_workspace:
92+
at: ~/project
93+
- run:
94+
name: 'Run linter'
95+
command: yarn lint:check
96+
97+
run-docs-linter-check:
98+
<<: *defaults
99+
steps:
100+
- checkout
101+
- attach_workspace:
102+
at: ~/project
103+
- run:
104+
name: 'Run md linter'
105+
command: yarn workspace docs lint-md
106+
107+
#------------------------------------------------------------
108+
# 3. Build VuePress
109+
#------------------------------------------------------------
110+
111+
build:
112+
<<: *defaults
113+
steps:
114+
- checkout
115+
- attach_workspace:
116+
at: ~/project
117+
- run:
118+
name: 'Run tests'
119+
command: yarn build
120+
121+
#------------------------------------------------------------
122+
# Workflows
123+
#------------------------------------------------------------
124+
125+
workflows:
126+
version: 2
127+
build:
128+
jobs:
129+
- install-dependencies
130+
- lerna-bootstrap: { requires: [install-dependencies] }
131+
- run-linter-check: { requires: [install-dependencies] }
132+
- run-docs-linter-check: { requires: [install-dependencies] }
133+
- run-tsc: { requires: [install-dependencies] }
134+
- run-tests: { requires: [run-tsc] }
135+
- build: { requires: [run-tests, run-linter-check, run-docs-linter-check, lerna-bootstrap] }

‎.eslintrc.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ module.exports = {
66
],
77
rules: {
88
indent: ['error', 2, { MemberExpression: 'off' }],
9-
"no-undef": ["error"]
9+
"no-undef": ["error"],
10+
'operator-linebreak': ["error", "before"]
1011
}
1112
}

‎.github/CONTRIBUTING.md

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
## Development Setup
2+
3+
This project uses a monorepo setup that requires using [Yarn](https://yarnpkg.com) because it relies on [Yarn workspaces](https://yarnpkg.com/blog/2017/08/02/introducing-workspaces/).
4+
5+
``` sh
6+
# Install dependencies & compile TypeScript utilities.
7+
yarn bootstrap
8+
9+
# Clean dependencies.
10+
yarn clean
11+
12+
# Useful when creating new submodules.
13+
yarn boot
14+
15+
# Serve the docs.
16+
yarn dev
17+
18+
# Build the docs.
19+
yarn build
20+
21+
# Execute all the test suites.
22+
yarn test
23+
```
24+
25+
## Core packages
26+
27+
- **docs**: Docs of VuePress (do not publish to npm).
28+
- **vuepress**: VuePress CLI.
29+
- **packages**
30+
- `core`: containing the Node.js API, the Plugin API, the Theme API, the Client SPA, etc.
31+
- `markdown`: internal Markdown compiler.
32+
- `markdown-loader`: internal Markdown loader.
33+
- `plugin-active-header-links`: a plugin for active sidebar heading links.
34+
- `plugin-google-analytics`: Google Analytics integration.
35+
- `plugin-last-updated`: implementation of "last updated" feature.
36+
- `plugin-medium-zoom`: `medium-zoom` integration.
37+
- `plugin-nprogress`: `nprogress` integration.
38+
- `plugin-pwa`: PWA plugin.
39+
- `plugin-search`: search plugin, providing the `SearchBox` component.
40+
- `shared-utils`: TypeScript utilities.
41+
- `test-utils`: test utilities.
42+
- `theme-default`: default theme.
43+
- `theme-vue`: a theme tweak from default theme, used for the official Vue project.
44+
45+
## Core packages not in main project
46+
47+
> Previously, for quick iteration, these projects were kept in ULIVZ's workspace. In the future, we may want to build an independent GitHub group.
48+
49+
- [awesome-vuepress](https://github.com/ulivz/awesome-vuepress)
50+
- [@vuepress/plugin-blog](https://github.com/ulivz/vuepress-plugin-blog)
51+
- [@vuepress/theme-blog](https://github.com/ulivz/vuepress-theme-blog)
52+
53+
## Workflow
54+
55+
### Issue
56+
57+
> TODO
58+
59+
### Pull requests
60+
61+
- Create a feature branch from the default branch (`master`) and merge back against that branch.
62+
- It's OK to have multiple small commits as you work on the PR - GitHub automatically squashes them before merging.
63+
- Make sure tests pass.
64+
- If adding a new feature:
65+
- Add accompanying test case(s).
66+
- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
67+
- If fixing bug:
68+
- If you are resolving an open issue, add `(fix #xxxx)` (`#xxxx` being the issue ID) in your PR title for a better release log, e.g. `chore(feat): implement SSR (fix #1234)`.
69+
- Provide a detailed description of the bug in the PR. Live demo preferred.
70+
- Add appropriate test coverage if applicable.
71+
72+
### Substantial Changes
73+
74+
> RFC flow, TODO
75+
76+
## Code Specification
77+
78+
> TODO
79+
80+
## Commit specification
81+
82+
Commit messages should follow the [commit message convention](./COMMIT_CONVENTION.md) so that changelogs can be automatically generated.

0 commit comments

Comments
 (0)