Skip to content

Commit b45b848

Browse files
GarthDBGarthDB
committed
wip setting up postcss-topdoc plugin
1 parent bdfed54 commit b45b848

File tree

12 files changed

+210
-52
lines changed

12 files changed

+210
-52
lines changed

‎.babelrc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"presets": ["es2015"],
3+
"plugins": ["add-module-exports"],
4+
"env": {
5+
"test": {
6+
"plugins": [ "istanbul" ]
7+
}
8+
}
9+
}

‎.cz-config.js‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
'use strict';
2+
3+
module.exports = {
4+
5+
types: [
6+
{value: 'feat', name: 'feat: A new feature'},
7+
{value: 'fix', name: 'fix: A bug fix'},
8+
{value: 'docs', name: 'docs: Documentation only changes'},
9+
{value: 'style', name: 'style: Changes that do not affect the meaning of the code\n (white-space, formatting, missing semi-colons, etc)'},
10+
{value: 'refactor', name: 'refactor: A code change that neither fixes a bug nor adds a feature'},
11+
{value: 'perf', name: 'perf: A code change that improves performance'},
12+
{value: 'test', name: 'test: Adding missing tests'},
13+
{value: 'chore', name: 'chore: Changes to the build process or auxiliary tools\n and libraries such as documentation generation'},
14+
{value: 'revert', name: 'revert: Revert to a commit'},
15+
{value: 'WIP', name: 'WIP: Work in progress'}
16+
],
17+
18+
allowBreakingChanges: ['feat', 'fix', 'perf']
19+
20+
};

‎.eslintrc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": "garthdb"
3+
}

‎.gitignore‎

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,42 @@
1-
node_modules
2-
npm-debug.log
1+
node_modules/
2+
tmp
3+
logs
4+
docs.json
5+
*.log
6+
npm-debug.log*
37
.DS_Store
4-
fulldocs
8+
/lib
9+
/bin
10+
11+
# Runtime data
12+
pids
13+
*.pid
14+
*.seed
15+
16+
# Directory for instrumented libs generated by jscoverage/JSCover
17+
lib-cov
18+
19+
# Coverage directory used by tools like istanbul
20+
coverage
21+
22+
# nyc test coverage
23+
.nyc_output
24+
25+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
26+
.grunt
27+
28+
# node-waf configuration
29+
.lock-wscript
30+
31+
# Compiled binary addons (http://nodejs.org/api/addons.html)
32+
build/Release
33+
34+
# Dependency directories
35+
node_modules
36+
jspm_packages
37+
38+
# Optional npm cache directory
39+
.npm
40+
41+
# Optional REPL history
42+
.node_repl_history

‎.npmignore‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1-
.DS_Store
2-
.travis.yml
3-
test
1+
src/
2+
test/
3+
.*
4+
coverage
5+
inch.json
6+
docs.json
7+
node_modules/
8+
npm-debug.log
9+
api.json

‎.travis.yml‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
language: node_js
2-
node_js:
3-
- "0.10"
2+
node_js: "6"
3+
before_script:
4+
- npm link
5+
script:
6+
- npm run validate
7+
after_success:
8+
- npm run codecov

‎LICENSE‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
Copyright (C) 2012 Adobe Systems Incorporated. All rights reserved.
2-
31
Apache License
42
Version 2.0, January 2004
53
http://www.apache.org/licenses/
@@ -180,15 +178,15 @@ Copyright (C) 2012 Adobe Systems Incorporated. All rights reserved.
180178
APPENDIX: How to apply the Apache License to your work.
181179

182180
To apply the Apache License to your work, attach the following
183-
boilerplate notice, with the fields enclosed by brackets "[]"
181+
boilerplate notice, with the fields enclosed by brackets "{}"
184182
replaced with your own identifying information. (Don't include
185183
the brackets!) The text should be enclosed in the appropriate
186184
comment syntax for the file format. We also recommend that a
187185
file or class name and description of purpose be included on the
188186
same "printed page" as the copyright notice for easier
189187
identification within third-party archives.
190188

191-
Copyright [yyyy] [name of copyright owner]
189+
Copyright {yyyy} {name of copyright owner}
192190

193191
Licensed under the Apache License, Version 2.0 (the "License");
194192
you may not use this file except in compliance with the License.
@@ -200,4 +198,4 @@ Copyright (C) 2012 Adobe Systems Incorporated. All rights reserved.
200198
distributed under the License is distributed on an "AS IS" BASIS,
201199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202200
See the License for the specific language governing permissions and
203-
limitations under the License.
201+
limitations under the License.

‎Makefile‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎inch.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"files": {
3+
"excluded": [
4+
"!regexp:/^lib/"
5+
]
6+
}
7+
}

‎package.json‎

Lines changed: 43 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,62 @@
11
{
2-
"author": "Garth Braithwaite <garthdb@gmail.com> (http://www.garthdb.com)",
32
"name": "topdoc",
43
"description": "Generate usage guides for css",
54
"version": "0.4.0",
6-
"repository": "git@github.com:topcoat/topdoc.git",
5+
"main": "./lib/topdoc",
6+
"bin": {
7+
"topdoc": "./bin/topdoc"
8+
},
9+
"scripts": {
10+
"prepublish": "npm run compile",
11+
"compile": "babel -d ./ ./src/",
12+
"test": "nyc ava",
13+
"coverage": "nyc npm test",
14+
"lint": "eslint .",
15+
"codecov": "nyc report -r lcovonly && codecov",
16+
"checkdocs": "atomdoc src",
17+
"validate": "npm run lint && npm run test && npm run checkdocs",
18+
"release": "semantic-release pre && npm publish && semantic-release post"
19+
},
20+
"repository": {
21+
"type": "git",
22+
"url": "https://github.com/topcoat/topdoc.git"
23+
},
724
"keywords": [
825
"css",
926
"style",
1027
"documentation",
1128
"usage"
1229
],
13-
"licenses": [
14-
{
15-
"type": "Apache 2.0",
16-
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
17-
}
18-
],
19-
"main": "./lib/topdoc",
20-
"bin": {
21-
"topdoc": "./bin/topdoc"
30+
"author": "Garth Braithwaite <garthdb@gmail.com> (http://garthdb.com)",
31+
"license": "Apache-2.0",
32+
"bugs": {
33+
"url": "https://github.com/topcoat/topdoc/issues"
2234
},
2335
"preferGlobal": "true",
24-
"scripts": {
25-
"test": "make test"
26-
},
2736
"dependencies": {
28-
"commander": "~1.2.0",
29-
"css-parse": "~1.4.0",
37+
"commander": "^2.9.0",
3038
"jade": "~0.31.2",
31-
"fs-extra": "~0.6.1",
32-
"async": "~0.2.9",
33-
"ncp": "~0.4.2",
34-
"js-yaml": "~2.1.0",
35-
"clean-css": "~2.0.2"
39+
"pkginfo": "^0.4.0",
40+
"postcss": "^5.2.4",
41+
"postcss-topdoc": "0.0.2",
42+
"resolve": "^1.1.7"
3643
},
3744
"devDependencies": {
38-
"mocha": "~1.11.0",
39-
"should": "~1.2.2",
40-
"topdoc-theme": "0.5.0"
45+
"atomdoc-cli": "^1.0.1",
46+
"ava": "^0.16.0",
47+
"babel-cli": "^6.16.0",
48+
"babel-core": "^6.17.0",
49+
"babel-plugin-add-module-exports": "^0.2.1",
50+
"babel-plugin-istanbul": "^2.0.1",
51+
"babel-preset-es2015": "^6.16.0",
52+
"babel-register": "^6.16.3",
53+
"codecov": "^1.0.1",
54+
"eslint": "^3.7.0",
55+
"eslint-config-garthdb": "^0.1.0",
56+
"nixt": "^0.5.0",
57+
"nyc": "^8.3.0",
58+
"semantic-release": "^4.3.5",
59+
"topdoc-theme": "^0.7.0"
4160
},
4261
"engines": {
4362
"node": "*"

0 commit comments

Comments
 (0)