Skip to content

Commit f7f555f

Browse files
pyramationpyramation
authored
Merge pull request #122 from cosmology-tech/boilerplates
Boilerplates
2 parents 94e56d5 + 14899f2 commit f7f555f

File tree

115 files changed

+6921
-2
lines changed

Some content is hidden

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

115 files changed

+6921
-2
lines changed

‎boilerplates/node-typescript/.editorconfig‎

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

‎boilerplates/node-typescript/.eslintignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules/
2+
dist/
3+
main/
4+
module/
5+
coverage/

‎boilerplates/node-typescript/.eslintrc.js‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
module.exports = {
2+
plugins: ['prettier'],
3+
extends: ['eslint:recommended', 'prettier'],
4+
parser: '@babel/eslint-parser',
5+
parserOptions: {
6+
ecmaVersion: 11,
7+
requireConfigFile: false,
8+
sourceType: 'module',
9+
ecmaFeatures: {
10+
jsx: true
11+
}
12+
},
13+
env: {
14+
es6: true,
15+
browser: true,
16+
node: true,
17+
jest: true
18+
},
19+
rules: {
20+
'no-debugger': 2,
21+
'no-alert': 2,
22+
'no-await-in-loop': 0,
23+
'no-prototype-builtins': 0,
24+
'no-return-assign': ['error', 'except-parens'],
25+
'no-restricted-syntax': [
26+
2,
27+
'ForInStatement',
28+
'LabeledStatement',
29+
'WithStatement'
30+
],
31+
'no-unused-vars': [
32+
0,
33+
{
34+
ignoreSiblings: true,
35+
argsIgnorePattern: 'React|res|next|^_'
36+
}
37+
],
38+
'prefer-const': [
39+
'error',
40+
{
41+
destructuring: 'all'
42+
}
43+
],
44+
'no-unused-expressions': [
45+
2,
46+
{
47+
allowTaggedTemplates: true
48+
}
49+
],
50+
'no-console': 1,
51+
'comma-dangle': 2,
52+
'jsx-quotes': [2, 'prefer-double'],
53+
'linebreak-style': ['error', 'unix'],
54+
quotes: [
55+
2,
56+
'single',
57+
{
58+
avoidEscape: true,
59+
allowTemplateLiterals: true
60+
}
61+
],
62+
'prettier/prettier': [
63+
'error',
64+
{
65+
trailingComma: 'none',
66+
singleQuote: true,
67+
printWidth: 80
68+
}
69+
]
70+
}
71+
};

‎boilerplates/node-typescript/.gitignore‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
6+
# Runtime data
7+
pids
8+
*.pid
9+
*.seed
10+
11+
# dist
12+
dist
13+
mjs
14+
main
15+
module
16+
17+
# Directory for instrumented libs generated by jscoverage/JSCover
18+
lib-cov
19+
20+
# Coverage directory used by tools like istanbul
21+
coverage
22+
23+
# nyc test coverage
24+
.nyc_output
25+
26+
# Compiled binary addons (http://nodejs.org/api/addons.html)
27+
build/Release
28+
29+
# Dependency directories
30+
node_modules
31+
jspm_packages
32+
33+
# Optional npm cache directory
34+
.npm
35+
36+
# Optional REPL history
37+
.node_repl_history
38+
39+
# Editors
40+
.idea
41+
42+
# Lib
43+
lib
44+
45+
# npm package lock
46+
package-lock.json
47+
yarn.lock
48+
49+
# others
50+
.DS_Store

‎boilerplates/node-typescript/.npmignore‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
*.log
2+
npm-debug.log*
3+
4+
# Coverage directory used by tools like istanbul
5+
coverage
6+
.nyc_output
7+
8+
# Dependency directories
9+
node_modules
10+
11+
# npm package lock
12+
package-lock.json
13+
yarn.lock
14+
15+
# project files
16+
__fixtures__
17+
__tests__
18+
.babelrc
19+
.babelrc.js
20+
.editorconfig
21+
.eslintignore
22+
.eslintrc
23+
.eslintrc.js
24+
.gitignore
25+
.travis.yml
26+
.vscode
27+
CHANGELOG.md
28+
examples
29+
jest.config.js
30+
package.json
31+
src
32+
test

‎boilerplates/node-typescript/.npmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
scripts-prepend-node-path=true

‎boilerplates/node-typescript/.questions.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
[
2+
{
3+
"name": "__USERFULLNAME__",
4+
"message": "Enter author full name",
5+
"required": true
6+
},
7+
{
8+
"name": "__USEREMAIL__",
9+
"message": "Enter author email",
10+
"required": true
11+
},
12+
{
13+
"name": "__MODULENAME__",
14+
"message": "Enter the module name",
15+
"required": true
16+
},
17+
{
18+
"name": "__MODULEDESC__",
19+
"message": "Enter the module description",
20+
"required": true
21+
},
22+
{
23+
"name": "__USERNAME__",
24+
"message": "Enter your github username",
25+
"required": true
26+
},
27+
{
28+
"name": "__ACCESS__",
29+
"message": "Module access?",
30+
"choices": [
31+
"public",
32+
"restricted"
33+
],
34+
"type": "list",
35+
"required": true
36+
}
37+
]

‎boilerplates/node-typescript/.vscode/settings.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"[javascriptreact]": {
4+
"editor.formatOnSave": false
5+
},
6+
"[javascript]": {
7+
"editor.formatOnSave": false
8+
},
9+
"editor.codeActionsOnSave": {
10+
"source.fixAll.eslint": true
11+
},
12+
"eslint.validate": [
13+
"javascript",
14+
"javascriptreact"
15+
]
16+
}

‎boilerplates/node-typescript/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2023 __USERFULLNAME__ <__USEREMAIL__>
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.

‎boilerplates/node-typescript/README.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# __MODULENAME__
2+
3+
<p align="center">
4+
<img src="https://user-images.githubusercontent.com/545047/188804067-28e67e5e-0214-4449-ab04-2e0c564a6885.svg" width="80"><br />
5+
__MODULEDESC__
6+
</p>
7+
8+
## install
9+
10+
```sh
11+
npm install __MODULENAME__
12+
```
13+
## Table of contents
14+
15+
- [__MODULENAME__](#__MODULENAME__)
16+
- [Install](#install)
17+
- [Table of contents](#table-of-contents)
18+
- [Developing](#developing)
19+
- [Credits](#credits)
20+
21+
## Developing
22+
23+
When first cloning the repo:
24+
25+
```
26+
yarn
27+
yarn build
28+
```
29+
30+
### Codegen
31+
32+
Contract schemas live in `./contracts`. Look inside of `scripts/codegen.js` and configure the settings for bundling your SDK and contracts into `__MODULENAME__`:
33+
34+
```
35+
yarn codegen
36+
```
37+
38+
### Publishing
39+
40+
Build the types and then publish:
41+
42+
```
43+
yarn build
44+
yarn publish
45+
```
46+
## Credits
47+
48+
🛠 Built by Cosmology — if you like our tools, please consider delegating to [our validator ⚛️](https://cosmology.tech/validator)
49+
50+
Code built with the help of these related projects:
51+
52+
* [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) for generated CosmWasm contract Typescript classes
53+
* [@osmonauts/telescope](https://github.com/osmosis-labs/telescope) a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
54+
* [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) A wallet connector for the Cosmos ⚛️
55+
56+
## Disclaimer
57+
58+
AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
59+
60+
No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code or software using the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

0 commit comments

Comments
 (0)