Skip to content

Commit 7c80b3d

Browse files
committed
chore: initial module structure
0 parents  commit 7c80b3d

32 files changed

+10274
-0
lines changed

.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_size = 2
5+
indent_style = space
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

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [manchenkoff]

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Bug report
3+
about: Create a report for a bug or incorrect behavior of the project
4+
title: "[Bug] Short description"
5+
labels: bug
6+
assignees: manchenkoff
7+
---
8+
9+
**Describe the bug**
10+
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
15+
Steps to reproduce the behavior:
16+
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. See error
20+
21+
**Expected behavior**
22+
23+
A clear and concise description of what you expected to happen.
24+
25+
**Screenshots**
26+
27+
If applicable, add screenshots to help explain your problem.
28+
29+
**Module information**
30+
31+
- Version: <INSTALLED_MODULE_VERSION>
32+
- Complete configuration of `echo` from your `nuxt.config.ts`
33+
34+
```typescript
35+
export default defineNuxtConfig({
36+
modules: ["nuxt-laravel-echo"],
37+
38+
echo: {
39+
baseUrl: "http://localhost:80",
40+
},
41+
});
42+
```
43+
44+
**Nuxt environment:**
45+
46+
- Version: <YOUR_NUXT_VERSION>
47+
- SSR Enabled: <YES/NO>
48+
- Environment: <LOCAL/PRODUCTION>
49+
50+
**Additional context**
51+
52+
Add any other context about the problem here. For instance, you can attach the details about the request/response of the application or logs from the backend to make this problem easier to understand.

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Question
3+
about: Choose this template if you have a question about the project or functionality
4+
title: "[Question] Short description"
5+
labels: investigate, question
6+
assignees: manchenkoff
7+
---
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[Feature] Short description"
5+
labels: enhancement
6+
assignees: manchenkoff
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
15+
A clear and concise description of what you want to happen.
16+
17+
**Describe alternatives you've considered**
18+
19+
A clear and concise description of 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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
**Is your PR related to a specific issue/feature? Please describe and mention issues.**
2+
3+
A clear and concise description of what was fixed or implemented.
4+
5+
**Additional context**
6+
7+
Add any other context or screenshots about the feature request here.
8+
9+
**Checklist:**
10+
11+
- [ ] Code style, linters and tests are passing
12+
- [ ] Backwards compatibility is maintained
13+
- [ ] Documentation is updated

.github/workflows/ci.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: CI
2+
3+
env:
4+
node_version: 20
5+
6+
concurrency:
7+
group: nuxt-laravel-echo-ci
8+
cancel-in-progress: false
9+
10+
on:
11+
workflow_dispatch: # manual trigger
12+
pull_request:
13+
branches:
14+
- main
15+
16+
jobs:
17+
lint:
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Enable corepack
25+
run: corepack enable
26+
27+
- name: Setup Node.js
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: ${{ env.node_version }}
31+
32+
- name: Install dependencies
33+
run: npx nypm@latest i
34+
35+
- name: Lint
36+
run: npm run lint
37+
38+
- name: Type check
39+
run: npm run test:types
40+
41+
test:
42+
runs-on: ubuntu-latest
43+
44+
steps:
45+
- name: Checkout
46+
uses: actions/checkout@v4
47+
48+
- name: Enable corepack
49+
run: corepack enable
50+
51+
- name: Setup Node.js
52+
uses: actions/setup-node@v4
53+
with:
54+
node-version: ${{ env.node_version }}
55+
56+
- name: Install dependencies
57+
run: npx nypm@latest i
58+
59+
- name: Test
60+
run: npm run test

.github/workflows/release.yml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Release
2+
3+
env:
4+
node_version: 20
5+
changelog_user: changelog_action
6+
changelog_email: [email protected]
7+
NODE_AUTH_TOKEN: ${{ secrets.npm_token }}
8+
NODE_REGISTRY: https://registry.npmjs.org/ # setup credentials for npm
9+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # pass token to generate changelog
10+
11+
concurrency:
12+
group: nuxt-laravel-echo-release
13+
cancel-in-progress: false
14+
15+
permissions:
16+
contents: write
17+
id-token: write
18+
19+
on:
20+
workflow_dispatch: # manual trigger
21+
22+
jobs:
23+
lint:
24+
runs-on: ubuntu-latest
25+
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v4
29+
30+
- name: Enable corepack
31+
run: corepack enable
32+
33+
- name: Setup Node.js
34+
uses: actions/setup-node@v4
35+
with:
36+
node-version: ${{ env.node_version }}
37+
38+
- name: Install dependencies
39+
run: npx nypm@latest i
40+
41+
- name: Validate package
42+
run: npm run validate
43+
44+
publish:
45+
runs-on: ubuntu-latest
46+
47+
steps:
48+
- name: Checkout
49+
uses: actions/checkout@v4
50+
with:
51+
fetch-depth: 0 # fetch all history for tags
52+
53+
- name: Enable corepack
54+
run: corepack enable
55+
56+
- name: Setup Node.js
57+
uses: actions/setup-node@v4
58+
with:
59+
node-version: ${{ env.node_version }}
60+
61+
- name: Install dependencies
62+
run: npx nypm@latest i
63+
64+
- name: Build
65+
run: npm run prepack
66+
67+
- name: Generate changelog and publish release
68+
run: |
69+
git config --global user.name "${{ env.changelog_user }}"
70+
git config --global user.email "${{ env.changelog_email }}"
71+
npm run changelogen --release --push --publish

.gitignore

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Dependencies
2+
node_modules
3+
4+
# Logs
5+
*.log*
6+
7+
# Temp directories
8+
.temp
9+
.tmp
10+
.cache
11+
12+
# Yarn
13+
**/.yarn/cache
14+
**/.yarn/*state*
15+
16+
# Generated dirs
17+
dist
18+
19+
# Nuxt
20+
.nuxt
21+
.output
22+
.data
23+
.vercel_build_output
24+
.build-*
25+
.netlify
26+
27+
# Env
28+
.env
29+
30+
# Testing
31+
reports
32+
coverage
33+
*.lcov
34+
.nyc_output
35+
36+
# VSCode
37+
.vscode/*
38+
!.vscode/settings.json
39+
!.vscode/tasks.json
40+
!.vscode/launch.json
41+
!.vscode/extensions.json
42+
!.vscode/*.code-snippets
43+
44+
# Intellij idea
45+
*.iml
46+
.idea
47+
48+
# OSX
49+
.DS_Store
50+
.AppleDouble
51+
.LSOverride
52+
.AppleDB
53+
.AppleDesktop
54+
Network Trash Folder
55+
Temporary Items
56+
.apdisk

.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
shamefully-hoist=true
2+
strict-peer-dependencies=false

.vscode/settings.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"eslint.experimental.useFlatConfig": true,
3+
"prettier.semi": false,
4+
"prettier.singleQuote": true,
5+
"prettier.tabWidth": 2,
6+
}

0 commit comments

Comments
 (0)