Skip to content

Commit dc0758c

Browse files
olivierbeaulieuolivierbeaulieu
committed
Copying the basic project setup from @dfuse/client
1 parent 08ba9c7 commit dc0758c

15 files changed

+4904
-54
lines changed

‎.gitignore

+21-54
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,28 @@
1-
# Logs
2-
logs
3-
*.log
4-
npm-debug.log*
5-
yarn-debug.log*
6-
yarn-error.log*
7-
8-
# Runtime data
9-
pids
10-
*.pid
11-
*.seed
12-
*.pid.lock
13-
14-
# Directory for instrumented libs generated by jscoverage/JSCover
15-
lib-cov
16-
17-
# Coverage directory used by tools like istanbul
18-
coverage
19-
20-
# nyc test coverage
21-
.nyc_output
22-
23-
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24-
.grunt
25-
26-
# Bower dependency directory (https://bower.io/)
27-
bower_components
28-
29-
# node-waf configuration
30-
.lock-wscript
31-
32-
# Compiled binary addons (https://nodejs.org/api/addons.html)
33-
build/Release
34-
35-
# Dependency directories
36-
node_modules/
37-
jspm_packages/
38-
39-
# TypeScript v1 declaration files
40-
typings/
1+
# Autoenv/Direnv
2+
.env
3+
.envrc
414

42-
# Optional npm cache directory
43-
.npm
5+
# Build
6+
docs/
7+
dist/
448

45-
# Optional eslint cache
46-
.eslintcache
9+
# Coverage
10+
coverage/
4711

48-
# Optional REPL history
49-
.node_repl_history
12+
# NPM
13+
package-lock.json
5014

51-
# Output of 'npm pack'
52-
*.tgz
15+
# Rollup
16+
.rpt2_cache
5317

54-
# Yarn Integrity file
55-
.yarn-integrity
18+
# System Files
19+
*.orig
20+
.DS_Store
21+
Thumbs.db
5622

57-
# dotenv environment variables file
58-
.env
23+
# VSCode
24+
.vscode/launch.json
5925

60-
# next.js build output
61-
.next
26+
# Yarn
27+
yarn-error.log
28+
node_modules/

‎.prettierignore

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Coverage
2+
/coverage
3+
4+
## Docs Theme Partials
5+
/docs/theme/partials/*.hbs
6+
7+
## Generated Files
8+
index.js
9+
/build
10+
/dist
11+
/types
12+
*.d.ts
13+
14+
## Git
15+
.git
16+
.gitignore
17+
18+
## NPM
19+
package-lock.json
20+
21+
## Prettier
22+
.prettierignore
23+
24+
## VSCode
25+
.vscode
26+
27+
## Yarn
28+
package.json
29+
yarn.lock

‎.prettierrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"arrowParens": "always",
3+
"printWidth": 100,
4+
"semi": false
5+
}

‎.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"editor.formatOnSave": true
3+
}

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 dfuse.io
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎jest.config.js

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
const { defaults } = require("jest-config")
2+
3+
module.exports = {
4+
moduleDirectories: ["<rootDir>/node_modules"],
5+
moduleFileExtensions: [...defaults.moduleFileExtensions, "ts", "tsx"],
6+
moduleNameMapper: {},
7+
transform: {
8+
"^.+\\.tsx?$": "ts-jest"
9+
},
10+
testEnvironment: "jsdom",
11+
testRegex: "((\\.|/)(test|spec))\\.(jsx?|tsx?)$",
12+
setupFilesAfterEnv: ["jest-expect-message"]
13+
14+
// coverageThreshold: {
15+
// global: {
16+
// branches: 42.4,
17+
// lines: 62.1,
18+
// functions: 33.8,
19+
// statements: 62.0
20+
// }
21+
// },
22+
// collectCoverage: true,
23+
// coverageReporters: ["json", "html"]
24+
}

‎package.json

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
{
2+
"name": "@dfuse/client",
3+
"version": "0.2.6",
4+
"description": "dfuse JavaScript/TypeScript Client Library (for [dfuse API](https://docs.dfuse.io/))",
5+
"sideEffects": false,
6+
"main": "dist/lib/index.js",
7+
"module": "dist/dfuse-client.es5.js",
8+
"browser": "dist/dfuse-client.umd.js",
9+
"typings": "dist/types/index.d.ts",
10+
"files": [
11+
"dist/*"
12+
],
13+
"repository": "https://github.com/dfuse-io/client-js",
14+
"author": {
15+
"name": "dfuse Developers",
16+
"email": "[email protected]",
17+
"url": "https://dfuse.io"
18+
},
19+
"contributors": [
20+
{
21+
"name": "Denis Carriere",
22+
"email": "[email protected]",
23+
"url": "https://eosnation.io"
24+
}
25+
],
26+
"license": "MIT",
27+
"scripts": {
28+
"check": "yarn lint && yarn test && yarn build",
29+
"prepublishOnly": "yarn build && yarn test",
30+
"prebuild": "rimraf docs dist",
31+
"build": "yarn run build:cjs && yarn run build:es && yarn run build:umd && yarn run build:docs",
32+
"build:cjs": "tsc --module commonjs",
33+
"build:es": "rollup -c rollup.config.es.js",
34+
"build:umd": "rollup -c rollup.config.umd.js && node scripts/compress-umd-build.js",
35+
"build:docs": "typedoc",
36+
"publish:latest": "yarn publish --public && node scripts/gh-publish-docs.js",
37+
"publish:next": "yarn publish --public --tag next",
38+
"postversion": "node scripts/gh-push.js",
39+
"lint": "tslint 'src/**/*.ts'",
40+
"lint:specific": "tslint",
41+
"start": "tsc --module commonjs --watch",
42+
"run:example": "yarn run ts-node -O '{\"module\":\"commonjs\"}'",
43+
"test": "jest"
44+
},
45+
"husky": {
46+
"hooks": {
47+
"_comment": "Use --no-verify to bypass",
48+
"pre-commit": "lint-staged && pretty-quick --staged",
49+
"pre-push": "yarn lint"
50+
}
51+
},
52+
"lint-staged": {
53+
"linters": {
54+
"**/*.ts": [
55+
"yarn lint:specific"
56+
]
57+
},
58+
"ignore": [
59+
"**/*.d.ts"
60+
]
61+
},
62+
"devDependencies": {
63+
"@types/jest": "^23.3.9",
64+
"@types/node-fetch": "^2.1.6",
65+
"husky": "^1.1.2",
66+
"jest": "^24.1.0",
67+
"lint-staged": "^7.3.0",
68+
"node-fetch": "^2.3.0",
69+
"prettier": "^1.14.3",
70+
"pretty-quick": "^1.8.0",
71+
"rimraf": "^2.6.3",
72+
"rollup": "^1.10.0",
73+
"rollup-plugin-commonjs": "^9.3.4",
74+
"rollup-plugin-ignore": "^1.0.5",
75+
"rollup-plugin-json": "^4.0.0",
76+
"rollup-plugin-node-resolve": "^4.2.3",
77+
"rollup-plugin-sourcemaps": "^0.4.2",
78+
"rollup-plugin-terser": "^4.0.4",
79+
"rollup-plugin-typescript2": "^0.20.1",
80+
"terser": "^3.17.0",
81+
"ts-jest": "^24.0.0",
82+
"ts-node": "^7.0.1",
83+
"tslint": "^5.11.0",
84+
"tslint-config-prettier": "^1.15.0",
85+
"typedoc": "^0.14.2",
86+
"typedoc-default-themes-extension": "^0.0.3",
87+
"typedoc-plugin-toc-group": "^0.0.4",
88+
"typescript": "^3.1.3"
89+
}
90+
}

‎rollup.config.es.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
const { esBuild } = require("./rollup.config")
2+
3+
module.exports = esBuild()

‎rollup.config.js

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
const { builtinModules } = require("module")
2+
const resolve = require("rollup-plugin-node-resolve")
3+
const commonjs = require("rollup-plugin-commonjs")
4+
const sourceMaps = require("rollup-plugin-sourcemaps")
5+
const typescript = require("rollup-plugin-typescript2")
6+
const json = require("rollup-plugin-json")
7+
const { terser } = require("rollup-plugin-terser")
8+
const ignore = require("rollup-plugin-ignore")
9+
10+
const pkg = require("./package.json")
11+
12+
module.exports = {
13+
esBuild: () =>
14+
build({
15+
output: { file: pkg.module, format: "es", sourcemap: true },
16+
external: []
17+
}),
18+
19+
umdBuild: () =>
20+
build({
21+
output: {
22+
file: pkg.browser,
23+
name: "dfuseClient",
24+
format: "umd",
25+
sourcemap: true
26+
},
27+
resolve: {
28+
browser: true
29+
},
30+
prePlugins: [ignore(builtinModules)],
31+
postPlugins: [terser()]
32+
})
33+
}
34+
35+
function build(options) {
36+
return {
37+
input: `src/index.ts`,
38+
output: options.output,
39+
external: options.external || [],
40+
watch: {
41+
include: "src/**"
42+
},
43+
plugins: [
44+
...(options.prePlugins || []),
45+
json(),
46+
typescript({ useTsconfigDeclarationDir: true }),
47+
commonjs(),
48+
resolve(options.resolve),
49+
sourceMaps(),
50+
...(options.postPlugins || [])
51+
]
52+
}
53+
}

‎rollup.config.umd.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
const { umdBuild } = require("./rollup.config")
2+
3+
module.exports = umdBuild()

‎src/index.ts

Whitespace-only changes.

‎tsconfig.json

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"compilerOptions": {
3+
/* Basic Options */
4+
"target": "es6",
5+
"module": "es2015",
6+
"lib": ["es2015", "es2016", "es2017", "dom"],
7+
"declaration": true,
8+
"declarationDir": "dist/types",
9+
"sourceMap": true,
10+
"outDir": "dist/lib",
11+
12+
/* Strict Type-Checking Options */
13+
"strict": true,
14+
15+
/* Module Resolution Options */
16+
"allowSyntheticDefaultImports": true,
17+
"moduleResolution": "node",
18+
"esModuleInterop": true
19+
},
20+
"files": ["src/index.ts"],
21+
22+
"includes": ["./src/**/*.ts"]
23+
}

‎tslint.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"defaultSeverity": "error",
3+
"extends": ["tslint:recommended", "tslint-config-prettier"],
4+
"jsRules": {},
5+
"rules": {
6+
"array-type": false,
7+
"object-literal-sort-keys": false,
8+
"interface-name": false,
9+
"interface-over-type-literal": false,
10+
"variable-name": false,
11+
"ordered-imports": false,
12+
"no-console": false,
13+
"only-arrow-functions": false,
14+
"no-bitwise": false,
15+
"max-classes-per-file": false,
16+
"member-ordering": false
17+
},
18+
"rulesDirectory": []
19+
}

‎typedoc.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"mode": "file",
3+
"out": "docs",
4+
"exclude": "**/*+.test.ts",
5+
"excludeNotExported": true,
6+
"excludePrivate": true,
7+
"listInvalidSymbolLinks": true,
8+
"theme": "./tools/docs/theme"
9+
}

0 commit comments

Comments
 (0)