Skip to content

Commit cd2ac63

Browse files
sjdemartinisjdemartini
committed
Initial commit
0 parents  commit cd2ac63

25 files changed

+25626
-0
lines changed

‎.cspell.json

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"version": "0.2",
3+
"language": "en",
4+
"words": ["esbuild", "mui-tiptap", "Tiptap", "mui", "octocat"],
5+
"flagWords": [],
6+
"ignorePaths": [
7+
"package.json",
8+
"package-lock.json",
9+
"yarn.lock",
10+
"tsconfig.json",
11+
"node_modules/**"
12+
]
13+
}

‎.czrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"path": "./node_modules/@ryansonshine/cz-conventional-changelog"
3+
}

‎.eslintrc.json

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"root": true,
3+
"env": {
4+
"es2021": true,
5+
"node": true
6+
},
7+
"parser": "@typescript-eslint/parser",
8+
"parserOptions": {
9+
"project": "./tsconfig.json"
10+
},
11+
"plugins": ["import", "@typescript-eslint"],
12+
"extends": [
13+
"eslint:recommended",
14+
"plugin:eslint-comments/recommended",
15+
"plugin:@typescript-eslint/eslint-recommended",
16+
"plugin:@typescript-eslint/recommended",
17+
"plugin:@typescript-eslint/recommended-requiring-type-checking",
18+
"plugin:@typescript-eslint/strict",
19+
"plugin:import/recommended",
20+
"plugin:import/typescript",
21+
"prettier"
22+
],
23+
"settings": {
24+
"import/resolver": {
25+
"typescript": {
26+
"project": "tsconfig.json"
27+
}
28+
}
29+
},
30+
"rules": {
31+
"import/order": [
32+
"error",
33+
{
34+
"alphabetize": {
35+
"order": "asc",
36+
"caseInsensitive": true
37+
}
38+
}
39+
],
40+
"import/no-extraneous-dependencies": "error",
41+
"import/no-mutable-exports": "error",
42+
"import/no-unused-modules": "error"
43+
}
44+
}

‎.github/ISSUE_TEMPLATE/bug_report.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the bug
11+
12+
A clear and concise description of what the bug is.
13+
14+
### To Reproduce
15+
16+
Steps to reproduce the behavior:
17+
1.
18+
2.
19+
3.
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+
### System (please complete the following information):
30+
31+
- mui-tiptap version: [e.g. 1.1.0]
32+
- tiptap version: [e.g. 2.0.0]
33+
- Browser: [e.g. Chrome, Firefox]
34+
- Node version: [e.g 16.4.2]
35+
- OS: [e.g. Ubuntu 22.04, macOS 11.4]
36+
37+
### Additional context
38+
39+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
### Is your feature request related to a problem? Please describe.
11+
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
### Describe the solution you'd like
15+
16+
A clear and concise description of what you want to happen.
17+
18+
### Describe alternatives you've considered
19+
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
### Additional context
23+
24+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Fixes #
2+
3+
## Description of the changes
4+
5+
-
6+
-
7+
-

‎.github/workflows/mui-tiptap.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: mui-tiptap
2+
3+
on: [push]
4+
5+
env:
6+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
7+
8+
jobs:
9+
mui-tiptap:
10+
runs-on: ubuntu-latest
11+
12+
concurrency:
13+
group: ${{ github.ref }}
14+
cancel-in-progress: true
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
- uses: volta-cli/action@v3
19+
- run: npm ci
20+
21+
- name: Dependencies audit
22+
run: npm audit --audit-level=moderate
23+
24+
- name: Build
25+
run: npm run build
26+
27+
- name: Format check
28+
run: npm run format:check
29+
30+
- name: Lint check
31+
run: npm run lint:check
32+
33+
- name: Spell check
34+
run: npm run spell:check
35+
36+
- name: Test
37+
run: npm run test
38+
39+
# TODO(Steven DeMartini): Set up releases later
40+
# - name: Release
41+
# env:
42+
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
43+
# NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
44+
# run: npm run semantic-release

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
build/
2+
node_modules/
3+
.nyc_output/
4+
coverage/
5+
.DS_Store

‎.npmignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules/
2+
.nyc_output/
3+
coverage/

‎.releaserc.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"branches": [
3+
"+([0-9])?(.{+([0-9]),x}).x",
4+
"main",
5+
"master",
6+
"next",
7+
"next-major",
8+
{
9+
"name": "beta",
10+
"prerelease": true
11+
},
12+
{
13+
"name": "alpha",
14+
"prerelease": true
15+
}
16+
],
17+
"repositoryUrl": "https://github.com/sjdemartini/mui-tiptap.git",
18+
"plugins": [
19+
"@semantic-release/commit-analyzer",
20+
"@semantic-release/release-notes-generator",
21+
"@semantic-release/changelog",
22+
"@semantic-release/npm",
23+
"@semantic-release/github"
24+
]
25+
}

‎.swcrc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"$schema": "https://json.schemastore.org/swcrc",
3+
"jsc": {
4+
"parser": {
5+
"syntax": "typescript"
6+
}
7+
},
8+
"module": {
9+
"type": "es6",
10+
"noInterop": false
11+
},
12+
"exclude": ["__tests__"],
13+
"sourceMaps": true,
14+
"minify": true
15+
}

‎.vscode/extensions.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"recommendations": [
3+
"dbaeumer.vscode-eslint",
4+
"esbenp.prettier-vscode",
5+
"streetsidesoftware.code-spell-checker"
6+
]
7+
}

‎.vscode/launch.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
3+
"version": "0.2.0",
4+
"configurations": [
5+
{
6+
"type": "pwa-node",
7+
"request": "launch",
8+
"name": "Debug Current Test File",
9+
"autoAttachChildProcesses": true,
10+
"skipFiles": ["<node_internals>/**", "**/node_modules/**"],
11+
"program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
12+
"args": ["run", "${relativeFile}"],
13+
"smartStep": true,
14+
"console": "integratedTerminal"
15+
}
16+
]
17+
}

‎.vscode/settings.json

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
// only use words from .cspell.json
3+
"cSpell.userWords": [],
4+
"cSpell.enabled": true,
5+
"editor.defaultFormatter": "esbenp.prettier-vscode",
6+
"editor.formatOnSave": true,
7+
"editor.insertSpaces": true,
8+
"files.exclude": {
9+
"**/node_modules/**": true,
10+
"htmlcov/": true,
11+
".coverage": true,
12+
"coverage.xml": true,
13+
"**/.eslintcache": true,
14+
"yarn-error.log": true
15+
},
16+
"files.trimTrailingWhitespace": true,
17+
"files.trimFinalNewlines": true,
18+
"files.insertFinalNewline": true,
19+
"[json]": {
20+
"editor.tabSize": 2
21+
},
22+
"[typescript][typescriptreact][javascript][javascriptreact]": {
23+
"editor.codeActionsOnSave": {
24+
"source.fixAll.eslint": true
25+
},
26+
"editor.tabSize": 2
27+
},
28+
"typescript.tsdk": "node_modules/typescript/lib",
29+
"typescript.enablePromptUseWorkspaceTsdk": true
30+
}

‎CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing Guidelines
2+
3+
_Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!_ :octocat:
4+
5+
### Contents
6+
7+
- [Code of Conduct](#book-code-of-conduct)
8+
- [How can I Contribute?](#inbox_tray-how-can-i-contribute)
9+
10+
> **This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.**
11+
12+
## :inbox_tray: How can I Contribute?
13+
14+
### GitHub issues
15+
16+
If you encounter a problem with this library or if you have a new feature you'd like to see in this project, please create [a new issue](https://github.com/sjdemartini/mui-tiptap/issues/new/choose).
17+
18+
### GitHub Pull requests
19+
20+
Please leverage the repository's own tools to make sure the code is aligned with our standards:
21+
22+
1. Run all check commands before submitting the PR (`type:check`, `format:check`, `lint:check`, `test:coverage` and `spell:check`)
23+
2. Please commit your changes and run a `setup` command so you can actually check how would the template look like once cleaned up
24+
3. Always leverage the `cz` command to create a commit. We heavily rely on this for automatic releases.

‎README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# mui-tiptap
2+
3+
![GitHub Workflow Status](https://github.com/sjdemartini/mui-tiptap/actions/workflows/mui-tiptap.yml/badge.svg?branch=main)
4+
5+
A Material-UI (MUI) styled WYSIWYG rich text editor, using Tiptap.

0 commit comments

Comments
 (0)