Skip to content

Commit ab4280f

Browse files
remidejjoshuaellis
remidej
and
joshuaellis
authored
chore: init repository tooling (#1)
* Init Vite react app * setup jest * Export types * setup husky and eslint * Delete public dir * feedback fixes pre pack-up * use pack-up * chore(tsconfig): fix types exporting * chore: set yarn berry version * Restore strapi eslint config * Use lint-staged via npx * Add github and markdown files --------- Co-authored-by: Josh <[email protected]>
1 parent 7e08a25 commit ab4280f

26 files changed

+10154
-2
lines changed

‎.editorconfig

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
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+
[{package.json,*.yml}]
12+
indent_style = space
13+
indent_size = 2
14+
15+
[*.md]
16+
trim_trailing_whitespace = false

‎.eslintignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist

‎.eslintrc

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"root": true,
3+
"extends": ["@strapi/eslint-config/front/typescript"],
4+
"parserOptions": {
5+
"project": ["./tsconfig.eslint.json"]
6+
},
7+
"settings": {
8+
"import/resolver": {
9+
"typescript": {
10+
"project": "./tsconfig.eslint.json"
11+
}
12+
}
13+
},
14+
"rules": {
15+
"check-file/no-index": "off"
16+
},
17+
"overrides": []
18+
}

‎.github/ISSUE_TEMPLATE/BUG_REPORT.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us improve this repo.
3+
title: '[bug]: '
4+
labels: ['issue: bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for filing a bug report!
10+
- type: textarea
11+
attributes:
12+
label: What version of `@strapi/blocks-react-renderer` are you using?
13+
placeholder: |
14+
- Npm version
15+
- Node.js version
16+
- React version:
17+
- `@strapi/blocks-react-renderer` version
18+
- Browser
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: "What's Wrong?"
24+
description: A concise description of what you expected to happen (please provide screenshots).
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: To Reproduce
30+
description: Steps to reproduce the behavior
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Expected Behaviour
36+
description: What you expected to happen
37+
validations:
38+
required: true

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: 🚀 Feature Request
2+
description: Submit a request for a new feature
3+
title: '[feat]: '
4+
labels: ['issue: enhancement']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for contributing a feature request!
10+
- type: textarea
11+
attributes:
12+
label: A clear and concise description of what the feature is
13+
validations:
14+
required: true
15+
- type: textarea
16+
attributes:
17+
label: Why should this feature be included?
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Please provide an example for how this would work

‎.github/PULL_REQUEST_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### What does it do?
2+
3+
Describe the technical changes you did.
4+
5+
### Why is it needed?
6+
7+
Describe the issue you are solving.
8+
9+
### How to test it?
10+
11+
Provide information about the environment and the path to verify the behaviour.
12+
13+
### Related issue(s)/PR(s)
14+
15+
Let us know if this is related to any issue/pull request

‎.gitignore

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
node_modules
5+
.pnp
6+
.pnp.js
7+
8+
# testing
9+
coverage
10+
11+
# production
12+
dist
13+
14+
# misc
15+
.DS_Store
16+
*.pem
17+
18+
# debug
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*
22+
23+
# local env files
24+
.env
25+
.env.local
26+
.env.development.local
27+
.env.test.local
28+
.env.production.local
29+
30+
# yarn
31+
.pnp.*
32+
.yarn/*
33+
!.yarn/patches
34+
!.yarn/plugins
35+
!.yarn/releases
36+
!.yarn/sdks
37+
!.yarn/versions

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npx --no-install lint-staged

‎.lintstagedrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"*.{js,jsx,ts,tsx}": ["yarn lint:fix"]
3+
}

‎.prettierignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist
2+
coverage

‎.prettierrc

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"endOfLine": "lf",
3+
"tabWidth": 2,
4+
"printWidth": 100,
5+
"singleQuote": true,
6+
"trailingComma": "es5"
7+
}

‎.yarn/releases/yarn-3.6.4.cjs

+874
Large diffs are not rendered by default.

‎.yarnrc.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
nodeLinker: node-modules
2+
3+
yarnPath: .yarn/releases/yarn-3.6.4.cjs

‎CODE_OF_CONDUCT.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Code of Conduct
2+
3+
This project and everyone participating in it are governed by the [Strapi Code of Conduct](https://github.com/strapi/strapi/blob/master/CODE_OF_CONDUCT.md).
4+
By participating, you are expected to uphold this code. Please read the [full text](https://github.com/strapi/strapi/blob/master/CODE_OF_CONDUCT.md)
5+
so that you can read which actions may or may not be tolerated.

‎LICENSE

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Copyright (c) 2015-present Strapi Solutions SAS
2+
3+
Portions of the Strapi software are licensed as follows:
4+
5+
* If you are accessing or using any component of the software that resides under an "ee/" directory, then you are deemed to be using our “Enterprise Edition” of the software and you understand and agree that the software is not licensed under the "MIT Expat" license as set forth below but instead, all the software you access is licensed under the license defined in "strapi/packages/core/admin/ee/LICENSE" and located at https://github.com/strapi/strapi/blob/a76b557047e9ef1c168dbf1b6cf879bcc3022de6/packages/core/admin/ee/LICENSE, unless (a) you or the company you represent has signed an alternative agreement referencing this code, then such signed agreement applies or (b) you are using the software in connection with a subscription to our cloud offering, then the terms of the agreement relevant to the cloud offering which you have assented to apply and the software licenses included in that agreement shall apply.
6+
7+
* If (a) you are not accessing or using the software that resides under an “ee/” directory and therefore you are only accessing or using our “Community Edition” of the Software and (b) you have no registered account on our cloud offering, then we are providing you the software under the "MIT Expat" license as set forth below.
8+
9+
MIT Expat License
10+
11+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,15 @@
1-
# blocks-react-renderer
2-
A React renderer for the Strapi's Blocks rich text editor
1+
# Strapi Blocks React Renderer
2+
3+
Easily render the content of Strapi's new Blocks rich text editor in your React frontend.
4+
5+
## Installation
6+
7+
Install the Blocks renderer and its peer dependencies:
8+
9+
```sh
10+
yarn add @strapi/blocks-react-renderer react react-dom
11+
```
12+
13+
```sh
14+
npm install @strapi/blocks-react-renderer react react-dom
15+
```

‎jest.config.mjs

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/** @type {import('jest').Config} */
2+
const config = {
3+
testEnvironment: 'jsdom',
4+
transform: {
5+
'^.+\\.(t|j)sx?$': '@swc/jest',
6+
},
7+
};
8+
9+
export default config;

‎package.json

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
{
2+
"name": "@strapi/blocks-react-renderer",
3+
"version": "0.0.0",
4+
"bugs": {
5+
"url": "https://github.com/strapi/blocks-react-renderer/issues"
6+
},
7+
"repository": {
8+
"type": "git",
9+
"url": "git://github.com/strapi/blocks-react-renderer.git"
10+
},
11+
"license": "SEE LICENSE IN LICENSE",
12+
"author": {
13+
"name": "Strapi Solutions SAS",
14+
"email": "[email protected]",
15+
"url": "https://strapi.io"
16+
},
17+
"maintainers": [
18+
{
19+
"name": "Strapi Solutions SAS",
20+
"email": "[email protected]",
21+
"url": "https://strapi.io"
22+
}
23+
],
24+
"type": "commonjs",
25+
"exports": {
26+
".": {
27+
"types": "./dist/index.d.ts",
28+
"require": "./dist/index.js",
29+
"import": "./dist/index.mjs",
30+
"source": "./src/index.ts",
31+
"default": "./dist/index.js"
32+
},
33+
"./package.json": "./package.json"
34+
},
35+
"main": "./dist/index.js",
36+
"module": "./dist/index.mjs",
37+
"source": "./src/index.ts",
38+
"types": "./dist/index.d.ts",
39+
"files": [
40+
"dist"
41+
],
42+
"scripts": {
43+
"build": "pack-up build",
44+
"check": "pack-up check",
45+
"lint": "eslint . --ext .cjs,.js,.ts,.tsx",
46+
"lint:fix": "yarn lint --fix",
47+
"postinstall": "husky install",
48+
"prepack": "pinst --disable",
49+
"postpack": "pinst --enable",
50+
"test": "yarn run test:ts && yarn run test:unit",
51+
"test:unit": "jest",
52+
"test:ts": "tsc --noEmit",
53+
"watch": "pack-up watch"
54+
},
55+
"dependencies": {
56+
"@testing-library/react": "^14.0.0",
57+
"lint-staged": "^15.0.1"
58+
},
59+
"devDependencies": {
60+
"@strapi/eslint-config": "^0.2.0",
61+
"@strapi/pack-up": "^4.14.4",
62+
"@swc/core": "^1.3.93",
63+
"@swc/jest": "^0.2.29",
64+
"@types/jest": "^29.5.5",
65+
"@types/react": "^18.0.0",
66+
"@types/react-dom": "^18.0.0",
67+
"@typescript-eslint/eslint-plugin": "^6.8.0",
68+
"@typescript-eslint/parser": "^6.8.0",
69+
"eslint": "^8.51.0",
70+
"eslint-config-prettier": "^9.0.0",
71+
"eslint-import-resolver-typescript": "^3.6.1",
72+
"eslint-plugin-check-file": "^2.6.2",
73+
"eslint-plugin-import": "^2.28.1",
74+
"eslint-plugin-jest-dom": "^5.1.0",
75+
"eslint-plugin-prettier": "^5.0.1",
76+
"eslint-plugin-react": "^7.33.2",
77+
"eslint-plugin-react-hooks": "^4.6.0",
78+
"eslint-plugin-testing-library": "^6.1.0",
79+
"husky": "^8.0.3",
80+
"jest": "^29.7.0",
81+
"jest-environment-jsdom": "^29.7.0",
82+
"prettier": "^3.0.3",
83+
"react": "^18.0.0",
84+
"react-dom": "^18.0.0",
85+
"typescript": "^5.2.2"
86+
},
87+
"peerDependencies": {
88+
"react": "^18.0.0",
89+
"react-dom": "^18.0.0"
90+
},
91+
"packageManager": "[email protected]",
92+
"resolutions": {
93+
"@typescript-eslint/typescript-estree": "^6.8.0"
94+
}
95+
}

‎src/BlocksRenderer/BlocksRenderer.tsx

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import * as React from 'react';
2+
3+
export const BlocksRenderer = () => {
4+
return (
5+
<div>
6+
<h1>BlocksRenderer</h1>
7+
</div>
8+
);
9+
};

‎src/BlocksRenderer/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from './BlocksRenderer';

‎src/BlocksRenderer/tests/BlocksRenderer.test.tsx

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import * as React from 'react';
2+
3+
import { render } from '@testing-library/react';
4+
5+
import { BlocksRenderer } from '../..';
6+
7+
describe('BlocksRenderer', () => {
8+
it('should render', () => {
9+
render(<BlocksRenderer />);
10+
});
11+
});

‎src/index.ts

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { BlocksRenderer } from './BlocksRenderer';
2+
3+
export { BlocksRenderer };

‎tsconfig.build.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"extends": "./tsconfig",
3+
"include": ["src"],
4+
"exclude": ["**/*.test.tsx"],
5+
"compilerOptions": {
6+
"outDir": "./dist"
7+
}
8+
}

‎tsconfig.eslint.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"extends": "./tsconfig",
3+
"include": ["src", "*.ts", "*.js"]
4+
}

‎tsconfig.json

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"include": ["src"],
3+
"compilerOptions": {
4+
"composite": false,
5+
"declaration": true,
6+
"declarationMap": true,
7+
"esModuleInterop": true,
8+
"forceConsistentCasingInFileNames": true,
9+
"inlineSources": false,
10+
"isolatedModules": true,
11+
"jsx": "react",
12+
"moduleResolution": "Bundler",
13+
"module": "ESNext",
14+
"noEmit": true,
15+
"noUnusedLocals": false,
16+
"noUnusedParameters": false,
17+
"preserveWatchOutput": true,
18+
"skipLibCheck": true,
19+
"strict": true
20+
}
21+
}

0 commit comments

Comments
 (0)