Skip to content

Commit f699522

Browse files
committed
[Update] Dotfiles and Configs
1 parent bdc7676 commit f699522

File tree

12 files changed

+10148
-10499
lines changed

12 files changed

+10148
-10499
lines changed

.eslintrc.cjs

Lines changed: 51 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,93 @@
11
module.exports = {
2-
"env": {
3-
"es6": true,
4-
"node": true,
5-
"browser": true,
6-
"jest/globals": true
2+
env: {
3+
es6: true,
4+
node: true,
5+
browser: true,
6+
"jest/globals": true,
77
},
8-
"parser": "@typescript-eslint/parser",
9-
"extends": ["eslint:recommended", "plugin:@typescript-eslint/eslint-recommended", "plugin:@typescript-eslint/recommended"],
10-
"parserOptions": {
11-
"sourceType": "module",
12-
"ecmaVersion": 2019
8+
parser: "@typescript-eslint/parser",
9+
extends: [
10+
"eslint:recommended",
11+
"plugin:@typescript-eslint/eslint-recommended",
12+
"plugin:@typescript-eslint/recommended",
13+
],
14+
parserOptions: {
15+
sourceType: "module",
16+
ecmaVersion: 2019,
1317
},
14-
"plugins": ["jsdoc", "jest", "svelte3", "@typescript-eslint"],
15-
"globals": {
16-
"fetch": false
18+
plugins: ["jsdoc", "jest", "svelte3", "@typescript-eslint"],
19+
globals: {
20+
fetch: false,
1721
},
18-
"settings": {
19-
"jsdoc": {
20-
"tagNamePreference": {
21-
"returns": "return"
22-
}
22+
settings: {
23+
jsdoc: {
24+
tagNamePreference: {
25+
returns: "return",
26+
},
2327
},
2428
"svelte3/typescript": require("typescript"),
2529
"svelte3/compiler-options": {
2630
customElement: true,
2731
},
2832
},
29-
"overrides": [
33+
overrides: [
3034
{
31-
"files": ["**/*.svelte"],
32-
"processor": "svelte3/svelte3"
33-
}
35+
files: ["**/*.svelte"],
36+
processor: "svelte3/svelte3",
37+
},
3438
],
35-
"rules": {
39+
rules: {
3640
"no-multi-spaces": [
3741
"error",
3842
{
39-
"ignoreEOLComments": true,
40-
"exceptions": {
41-
"VariableDeclarator": true
42-
}
43-
}
43+
ignoreEOLComments: true,
44+
exceptions: {
45+
VariableDeclarator: true,
46+
},
47+
},
4448
],
4549
"block-spacing": ["error", "always"],
4650
"array-bracket-spacing": ["error", "never"],
4751
"space-in-parens": ["error", "never"],
4852
"comma-spacing": [
4953
"error",
5054
{
51-
"before": false,
52-
"after": true
53-
}
55+
before: false,
56+
after: true,
57+
},
5458
],
5559
"key-spacing": [
5660
"error",
5761
{
58-
"afterColon": true,
59-
"beforeColon": false
60-
}
61-
],
62-
"indent": [
63-
"error",
64-
"tab",
65-
{
66-
"SwitchCase": 1
67-
}
62+
afterColon: true,
63+
beforeColon: false,
64+
},
6865
],
69-
"quotes": [
66+
quotes: [
7067
"error",
7168
"double",
7269
{
73-
"avoidEscape": true,
74-
"allowTemplateLiterals": true
75-
}
70+
avoidEscape: true,
71+
allowTemplateLiterals: true,
72+
},
7673
],
77-
"semi": ["error", "always"],
74+
semi: ["error", "always"],
7875
"no-console": ["warn"],
7976
"no-constant-condition": ["warn"],
80-
"curly": ["error", "all"],
77+
curly: ["error", "all"],
8178
"brace-style": [
8279
"error",
8380
"1tbs",
8481
{
85-
"allowSingleLine": false
86-
}
82+
allowSingleLine: false,
83+
},
8784
],
8885
"keyword-spacing": [
8986
"error",
9087
{
91-
"before": true,
92-
"after": true
93-
}
88+
before: true,
89+
after: true,
90+
},
9491
],
9592
"object-curly-spacing": ["error", "always"],
9693
"no-mixed-spaces-and-tabs": ["error", "smart-tabs"],
@@ -116,6 +113,6 @@ module.exports = {
116113
"jsdoc/require-returns-description": 1,
117114
"jsdoc/require-returns-type": 1,
118115
"jsdoc/require-returns-check": 1,
119-
"jsdoc/require-hyphen-before-param-description": 1
120-
}
116+
"jsdoc/require-hyphen-before-param-description": 1,
117+
},
121118
};

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ npm-debug.log
123123
#######
124124
/app/configs/config.js
125125
/app/configs/config.ts
126+
/app/configs/config.json
126127
/extra
127128
/dist
128129
/build

.prettierignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/dist
2+
/build
3+
/node_modules
4+
package-lock.json

.prettierrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"bracketSpacing": true,
3-
"printWidth": 160,
3+
"printWidth": 120,
44
"semi": true,
55
"singleQuote": false,
66
"tabWidth": 4,

.vscode/settings.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
},
77
"eslint.format.enable": true,
88
"[javascript]": {
9-
"editor.defaultFormatter": "dbaeumer.vscode-eslint"
9+
"editor.defaultFormatter": "esbenp.prettier-vscode"
1010
},
1111
"[typescript]": {
12-
"editor.defaultFormatter": "vscode.typescript-language-features"
12+
"editor.defaultFormatter": "esbenp.prettier-vscode"
1313
},
1414
"[scss]": {
1515
"editor.defaultFormatter": "esbenp.prettier-vscode"

README.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,11 @@ See [Demo here](https://codepen.io/ptkdev/pen/jOyNmEQ).
7878
1. Add html code to your page:
7979

8080
```html
81-
<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>
81+
<svelte-webcomponent-boilerplate
82+
header="make"
83+
flip="svelte,webcomponents,opensource"
84+
footer="awesome!"
85+
></svelte-webcomponent-boilerplate>
8286
```
8387

8488
2. Require javascript in yourpage (before `</body>`):
@@ -97,7 +101,11 @@ Below is available a description of `options` values.
97101
2. Add html code to your page:
98102

99103
```html
100-
<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>
104+
<svelte-webcomponent-boilerplate
105+
header="make"
106+
flip="svelte,webcomponents,opensource"
107+
footer="awesome!"
108+
></svelte-webcomponent-boilerplate>
101109
```
102110

103111
3. Require javascript in your app:
@@ -120,7 +128,11 @@ Below is available a description of `options` values.
120128
1. Add code to your html widget, example: `Appearance` --> `Widget` --> insert `HTML Widget` and paste html code:
121129

122130
```html
123-
<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>
131+
<svelte-webcomponent-boilerplate
132+
header="make"
133+
flip="svelte,webcomponents,opensource"
134+
footer="awesome!"
135+
></svelte-webcomponent-boilerplate>
124136
```
125137

126138
You can insert this html code in posts, widget, html box or theme.
@@ -137,7 +149,11 @@ import "@ptkdev/svelte-webcomponent-boilerplate";
137149
3. Add html code to your `App.js` template:
138150

139151
```html
140-
<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>
152+
<svelte-webcomponent-boilerplate
153+
header="make"
154+
flip="svelte,webcomponents,opensource"
155+
footer="awesome!"
156+
></svelte-webcomponent-boilerplate>
141157
```
142158

143159
## 🔴 Installation (Angular)
@@ -152,7 +168,11 @@ import "@ptkdev/svelte-webcomponent-boilerplate";
152168
3. Add html code to your html component:
153169

154170
```html
155-
<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>
171+
<svelte-webcomponent-boilerplate
172+
header="make"
173+
flip="svelte,webcomponents,opensource"
174+
footer="awesome!"
175+
></svelte-webcomponent-boilerplate>
156176
```
157177

158178
## 🟠 Installation (Svelte)
@@ -167,7 +187,11 @@ import "@ptkdev/svelte-webcomponent-boilerplate";
167187
3. Add html code to your html component:
168188

169189
```html
170-
<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>
190+
<svelte-webcomponent-boilerplate
191+
header="make"
192+
flip="svelte,webcomponents,opensource"
193+
footer="awesome!"
194+
></svelte-webcomponent-boilerplate>
171195
```
172196

173197
## 🟢 Installation (Vue)
@@ -185,7 +209,11 @@ Vue.config.ignoredElements = ["svelte-webcomponent-boilerplate"];
185209
3. Add html code to your html component:
186210

187211
```html
188-
<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>
212+
<svelte-webcomponent-boilerplate
213+
header="make"
214+
flip="svelte,webcomponents,opensource"
215+
footer="awesome!"
216+
></svelte-webcomponent-boilerplate>
189217
```
190218

191219
## 🧰 Options / Attributes
@@ -199,7 +227,11 @@ Vue.config.ignoredElements = ["svelte-webcomponent-boilerplate"];
199227
#### HTML Code with attributes:
200228

201229
```html
202-
<svelte-webcomponent-boilerplate header="make" flip="svelte,webcomponents,opensource" footer="awesome!"></svelte-webcomponent-boilerplate>
230+
<svelte-webcomponent-boilerplate
231+
header="make"
232+
flip="svelte,webcomponents,opensource"
233+
footer="awesome!"
234+
></svelte-webcomponent-boilerplate>
203235
```
204236

205237
## 🎨 CSS Customization

app/functions/webcomponent.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ const webcomponent = async ({ text }: ModuleInterface): Promise<ModuleResponseIn
2828
const app = () => text;
2929

3030
return {
31-
app
31+
app,
3232
};
3333
};
3434

app/types/webcomponent.type.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface ModuleInterface {
2626
* @param {string} text - input text
2727
*
2828
*/
29-
text: string
29+
text: string;
3030
}
3131

3232
/**
@@ -40,10 +40,10 @@ export interface ModuleResponseInterface {
4040
* =====================
4141
* Get text
4242
*
43-
* @interface [ModuleResponseInterface](https://github.com/ptkdev-boilerplate/svelte-webcomponent-boilerplate/blob/main/app/webcomponent/types/module.type.ts)
43+
* @interface [ModuleResponseInterface](https://github.com/ptkdev-boilerplate/svelte-webcomponent-boilerplate/blob/main/app/webcomponent/types/module.type.ts)
4444
*
4545
* @return {fn} string - run app() for output text
4646
*
4747
*/
48-
app(): string
48+
app(): string;
4949
}

0 commit comments

Comments
 (0)