Skip to content

Commit fe9eac1

Browse files
committed
build: prototype
1 parent 89aa5f2 commit fe9eac1

File tree

158 files changed

+15391
-0
lines changed

Some content is hidden

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

158 files changed

+15391
-0
lines changed

.commitlintrc.js

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
const fs = require('fs')
2+
const path = require('path')
3+
4+
const packages = fs.readdirSync(path.resolve(__dirname, 'packages/@vuepress'))
5+
6+
module.exports = {
7+
extends: ['@commitlint/config-conventional'],
8+
rules: {
9+
'scope-enum': [2, 'always', ['vuepress', ...packages]],
10+
},
11+
}

.editorconfig

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

.eslintignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
node_modules/
2+
!.vuepress/
3+
!.eslintrc.js
4+
!.commitlintrc.js
5+
lib/
6+
dist/

.eslintrc.js

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
module.exports = {
2+
root: true,
3+
extends: 'vuepress',
4+
overrides: [
5+
{
6+
files: ['*.ts'],
7+
extends: 'vuepress-typescript',
8+
rules: {
9+
'@typescript-eslint/ban-ts-ignore': 'off',
10+
'@typescript-eslint/no-var-requires': 'off',
11+
},
12+
},
13+
{
14+
files: ['**/__tests__/**/*.ts'],
15+
env: {
16+
jest: true,
17+
},
18+
rules: {
19+
'@typescript-eslint/explicit-function-return-type': 'off',
20+
},
21+
},
22+
],
23+
24+
rules: {
25+
// TODO: disable for vue 3 Fragment feature
26+
'vue/valid-template-root': 'off',
27+
},
28+
}

.gitattributes

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
* text=auto
2+
3+
*.txt text eol=crlf
4+
5+
*.png binary
6+
*.jpg binary
7+
*.jpeg binary
8+
*.ico binary
9+
*.tff binary
10+
*.woff binary
11+
*.woff2 binary

.github/ISSUE_TEMPLATE/bug_report.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve
4+
title: '[Bug Report] '
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
## Environment
10+
11+
<!-- Please provide the environment info -->
12+
13+
<!--
14+
For example:
15+
- VuePress version: vuepress@2.0.0
16+
- OS: Windows 10 x64
17+
- Browser: Chrome 75.0.3770.100
18+
-->
19+
20+
- VuePress version:
21+
- OS:
22+
- Browser:
23+
24+
## Describe the bug
25+
26+
<!-- A clear and concise description of what the bug is. -->
27+
28+
## Steps To Reproduce
29+
30+
<!-- If possbile, please create a reproduce repository so we can reproduce the bug quickly. -->
31+
32+
<!--
33+
Steps to reproduce the behavior, for example:
34+
1. Go to '...'
35+
2. Click on '....'
36+
3. Scroll down to '....'
37+
4. See error
38+
-->
39+
40+
## Screenshots
41+
42+
<!-- If applicable, add screenshots to help explain your problem. -->
43+
44+
## Expected behavior
45+
46+
<!-- A clear and concise description of what you expected to happen. -->
47+
48+
## Additional context
49+
50+
<!-- Add any other context about the problem here. -->
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea
4+
title: '[Feature Request] '
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
## What problem does the feature solve?
10+
11+
<!-- A clear and concise description of what the problem is, and why we need this feature. -->
12+
13+
## Proposed solution
14+
15+
<!-- Describe what you want to happen, and the solution you'd like. -->
16+
17+
## Alternative solutions
18+
19+
<!-- Any alternative solutions or features you've considered. -->
20+
21+
## Additional context
22+
23+
<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!-- Please don't delete this template -->
2+
3+
<!-- PULL REQUEST TEMPLATE -->
4+
<!-- (Update "[ ]" to "[x]" to check a box) -->
5+
6+
**Summary**
7+
8+
<!-- close #xxx -->
9+
10+
<!-- fix foo bug -->
11+
12+
<!-- add bar feature -->
13+
14+
**What kind of change does this PR introduce?** (check at least one)
15+
16+
- [ ] Bug fix (fix)
17+
- [ ] Feature (feat)
18+
- [ ] Performance enhancement (perf)
19+
- [ ] Code Style (style)
20+
- [ ] Refactor (refactor)
21+
- [ ] Docs (docs)
22+
- [ ] Build-related changes (build)
23+
- [ ] CI-related changes (ci)
24+
- [ ] Testing (test)
25+
- [ ] Other, please describe:
26+
27+
**Does this PR introduce a breaking change?** (check one)
28+
29+
- [ ] Yes
30+
- [ ] No
31+
32+
If yes, please describe the impact and migration path for existing applications:
33+
34+
**The PR fulfills these requirements**
35+
36+
- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
37+
38+
**Other information**
39+
40+
<!-- other related information, additional context -->

.github/lock.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Configuration for Lock Threads - https://github.com/dessant/lock-threads
2+
3+
# Number of days of inactivity before a closed issue or pull request is locked
4+
daysUntilLock: 120
5+
6+
# Skip issues and pull requests created before a given timestamp. Timestamp must
7+
# follow ISO 8601 (`YYYY-MM-DD`). Set to `false` to disable
8+
skipCreatedBefore: false
9+
10+
# Issues and pull requests with these labels will be ignored. Set to `[]` to disable
11+
exemptLabels: []
12+
13+
# Label to add before locking, such as `outdated`. Set to `false` to disable
14+
lockLabel: false
15+
16+
# Comment to post before locking. Set to `false` to disable
17+
lockComment: >
18+
This thread has been automatically locked since there has not been
19+
any recent activity after it was closed. Please open a new issue for
20+
related bugs.
21+
22+
# Assign `resolved` as the reason for locking. Set to `false` to disable
23+
setLockReason: true
24+
# Limit to only `issues` or `pulls`
25+
# only: issues
26+
27+
# Optionally, specify configuration settings just for `issues` or `pulls`
28+
# issues:
29+
# exemptLabels:
30+
# - help-wanted
31+
# lockLabel: outdated
32+
33+
# pulls:
34+
# daysUntilLock: 30
35+
36+
# Repository to extend settings from
37+
# _extends: repo

.github/stale.yml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an Issue or Pull Request becomes stale
4+
daysUntilStale: 60
5+
6+
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
7+
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
8+
daysUntilClose: 7
9+
10+
# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
11+
onlyLabels: []
12+
13+
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
14+
exemptLabels:
15+
- bug
16+
17+
# Set to true to ignore issues in a project (defaults to false)
18+
exemptProjects: false
19+
20+
# Set to true to ignore issues in a milestone (defaults to false)
21+
exemptMilestones: false
22+
23+
# Set to true to ignore issues with an assignee (defaults to false)
24+
exemptAssignees: false
25+
26+
# Label to use when marking as stale
27+
staleLabel: stale
28+
29+
# Comment to post when marking as stale. Set to `false` to disable
30+
markComment: >
31+
This issue has been automatically marked as stale because it has not had
32+
recent activity. It will be closed if no further activity occurs. Thank you
33+
for your contributions.
34+
35+
# Comment to post when removing the stale label.
36+
# unmarkComment: >
37+
# Your comment here.
38+
39+
# Comment to post when closing a stale Issue or Pull Request.
40+
# closeComment: >
41+
# Your comment here.
42+
43+
# Limit the number of actions per hour, from 1-30. Default is 30
44+
limitPerRun: 30
45+
# Limit to only `issues` or `pulls`
46+
# only: issues
47+
48+
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
49+
# pulls:
50+
# daysUntilStale: 30
51+
# markComment: >
52+
# This pull request has been automatically marked as stale because it has not had
53+
# recent activity. It will be closed if no further activity occurs. Thank you
54+
# for your contributions.
55+
56+
# issues:
57+
# exemptLabels:
58+
# - confirmed

.gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Temp files
2+
.temp/
3+
4+
# Dist files
5+
lib/
6+
7+
# Test coverage files
8+
coverage/
9+
10+
# Node modules
11+
node_modules/
12+
13+
# MacOS Desktop Services Store
14+
.DS_Store
15+
16+
# Log files
17+
*.log
18+
19+
# Typescript build info
20+
*.tsbuildinfo

.vscode/settings.json

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"editor.insertSpaces": true,
3+
"editor.tabSize": 2,
4+
"files.encoding": "utf8",
5+
"files.eol": "\n",
6+
"files.trimFinalNewlines": true,
7+
"files.trimTrailingWhitespace": true,
8+
"[markdown]": {
9+
"files.trimTrailingWhitespace": false
10+
},
11+
"eslint.validate": [
12+
"javascript",
13+
"javascriptreact",
14+
"typescript",
15+
"typescriptreact",
16+
"vue"
17+
],
18+
"vetur.validation.template": false,
19+
"cSpell.words": [
20+
"devtool",
21+
"frontmatter",
22+
"globby",
23+
"mathjax",
24+
"mergeable",
25+
"netlify",
26+
"nprogress",
27+
"prefetch",
28+
"preload",
29+
"redirector",
30+
"redirectors",
31+
"serializers",
32+
"vuepress",
33+
"zoomable"
34+
]
35+
}

README.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# vuepress-next
2+
3+
> With the power of Vue 3.0 and TypeScript
4+
5+
## Status: Prototype
6+
7+
Lots of functions are not completed. Just for preview.
8+
9+
It won't enter alpha stage before the upstream packages (e.g. vue, vue-router, etc) release a stable version.
10+
11+
### TODO
12+
13+
- [x] Plugin API
14+
- [ ] Theme API
15+
- [ ] Style processors
16+
- [ ] Palette system
17+
- [ ] Default theme
18+
- [ ] Pre-render (SSR build)
19+
- [ ] Watch & Reload
20+
- [ ] CLI
21+
- [ ] Official plugins
22+
- [ ] ...
23+
24+
## Develop & Preview
25+
26+
```sh
27+
# install
28+
yarn
29+
30+
# build with --watch
31+
yarn dev
32+
# build
33+
yarn build
34+
35+
# run playground script
36+
yarn play
37+
```

0 commit comments

Comments
 (0)