chore: init repository tooling (#1)

remidej · joshuaellis · web-flow · commit ab4280fe0e32 · 2023-10-18T09:54:57.000+02:00
* 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 &lt;37798644+joshuaellis@users.noreply.github.com&gt;
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{package.json,*.yml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+dist
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,18 @@
+{
+  "root": true,
+  "extends": ["@strapi/eslint-config/front/typescript"],
+  "parserOptions": {
+    "project": ["./tsconfig.eslint.json"]
+  },
+  "settings": {
+    "import/resolver": {
+      "typescript": {
+        "project": "./tsconfig.eslint.json"
+      }
+    }
+  },
+  "rules": {
+    "check-file/no-index": "off"
+  },
+  "overrides": []
+}
diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml
@@ -0,0 +1,38 @@
+name: 🐛 Bug Report
+description: Create a report to help us improve this repo.
+title: '[bug]: '
+labels: ['issue: bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filing a bug report!
+  - type: textarea
+    attributes:
+      label: What version of `@strapi/blocks-react-renderer` are you using?
+      placeholder: |
+        - Npm version
+        - Node.js version
+        - React version:
+        - `@strapi/blocks-react-renderer` version
+        - Browser
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "What's Wrong?"
+      description: A concise description of what you expected to happen (please provide screenshots).
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behaviour
+      description: What you expected to happen
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
@@ -0,0 +1,22 @@
+name: 🚀 Feature Request
+description: Submit a request for a new feature
+title: '[feat]: '
+labels: ['issue: enhancement']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for contributing a feature request!
+  - type: textarea
+    attributes:
+      label: A clear and concise description of what the feature is
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Why should this feature be included?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Please provide an example for how this would work
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,15 @@
+### What does it do?
+
+Describe the technical changes you did.
+
+### Why is it needed?
+
+Describe the issue you are solving.
+
+### How to test it?
+
+Provide information about the environment and the path to verify the behaviour.
+
+### Related issue(s)/PR(s)
+
+Let us know if this is related to any issue/pull request
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,37 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+node_modules
+.pnp
+.pnp.js
+
+# testing
+coverage
+
+# production
+dist
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# yarn
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no-install lint-staged
diff --git a/.lintstagedrc b/.lintstagedrc
@@ -0,0 +1,3 @@
+{
+  "*.{js,jsx,ts,tsx}": ["yarn lint:fix"]
+}
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,2 @@
+dist
+coverage
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,7 @@
+{
+  "endOfLine": "lf",
+  "tabWidth": 2,
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "es5"
+}
diff --git a/.yarn/releases/yarn-3.6.4.cjs b/.yarn/releases/yarn-3.6.4.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-3.6.4.cjs
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,5 @@
+# Code of Conduct
+
+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).
+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)
+so that you can read which actions may or may not be tolerated.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,15 @@
+Copyright (c) 2015-present Strapi Solutions SAS
+ 
+Portions of the Strapi software are licensed as follows:
+ 
+* 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.
+ 
+* 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.
+ 
+MIT Expat License
+ 
+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:
+ 
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ 
+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.
diff --git a/README.md b/README.md
@@ -1,2 +1,15 @@
-# blocks-react-renderer
-A React renderer for the Strapi's Blocks rich text editor
+# Strapi Blocks React Renderer
+
+Easily render the content of Strapi's new Blocks rich text editor in your React frontend.
+
+## Installation
+
+Install the Blocks renderer and its peer dependencies:
+
+```sh
+yarn add @strapi/blocks-react-renderer react react-dom
+```
+
+```sh
+npm install @strapi/blocks-react-renderer react react-dom
+```
diff --git a/jest.config.mjs b/jest.config.mjs
@@ -0,0 +1,9 @@
+/** @type {import('jest').Config} */
+const config = {
+  testEnvironment: 'jsdom',
+  transform: {
+    '^.+\\.(t|j)sx?$': '@swc/jest',
+  },
+};
+
+export default config;
diff --git a/package.json b/package.json
@@ -0,0 +1,95 @@
+{
+  "name": "@strapi/blocks-react-renderer",
+  "version": "0.0.0",
+  "bugs": {
+    "url": "https://github.com/strapi/blocks-react-renderer/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/strapi/blocks-react-renderer.git"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "author": {
+    "name": "Strapi Solutions SAS",
+    "email": "hi@strapi.io",
+    "url": "https://strapi.io"
+  },
+  "maintainers": [
+    {
+      "name": "Strapi Solutions SAS",
+      "email": "hi@strapi.io",
+      "url": "https://strapi.io"
+    }
+  ],
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "source": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pack-up build",
+    "check": "pack-up check",
+    "lint": "eslint . --ext .cjs,.js,.ts,.tsx",
+    "lint:fix": "yarn lint --fix",
+    "postinstall": "husky install",
+    "prepack": "pinst --disable",
+    "postpack": "pinst --enable",
+    "test": "yarn run test:ts && yarn run test:unit",
+    "test:unit": "jest",
+    "test:ts": "tsc --noEmit",
+    "watch": "pack-up watch"
+  },
+  "dependencies": {
+    "@testing-library/react": "^14.0.0",
+    "lint-staged": "^15.0.1"
+  },
+  "devDependencies": {
+    "@strapi/eslint-config": "^0.2.0",
+    "@strapi/pack-up": "^4.14.4",
+    "@swc/core": "^1.3.93",
+    "@swc/jest": "^0.2.29",
+    "@types/jest": "^29.5.5",
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-check-file": "^2.6.2",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jest-dom": "^5.1.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-testing-library": "^6.1.0",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "prettier": "^3.0.3",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "typescript": "^5.2.2"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "packageManager": "yarn@3.6.4",
+  "resolutions": {
+    "@typescript-eslint/typescript-estree": "^6.8.0"
+  }
+}
diff --git a/src/BlocksRenderer/BlocksRenderer.tsx b/src/BlocksRenderer/BlocksRenderer.tsx
@@ -0,0 +1,9 @@
+import * as React from 'react';
+
+export const BlocksRenderer = () => {
+  return (
+    <div>
+      <h1>BlocksRenderer</h1>
+    </div>
+  );
+};
diff --git a/src/BlocksRenderer/index.ts b/src/BlocksRenderer/index.ts
@@ -0,0 +1 @@
+export * from './BlocksRenderer';
diff --git a/src/BlocksRenderer/tests/BlocksRenderer.test.tsx b/src/BlocksRenderer/tests/BlocksRenderer.test.tsx
@@ -0,0 +1,11 @@
+import * as React from 'react';
+
+import { render } from '@testing-library/react';
+
+import { BlocksRenderer } from '../..';
+
+describe('BlocksRenderer', () => {
+  it('should render', () => {
+    render(<BlocksRenderer />);
+  });
+});
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,3 @@
+import { BlocksRenderer } from './BlocksRenderer';
+
+export { BlocksRenderer };
diff --git a/tsconfig.build.json b/tsconfig.build.json
@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig",
+  "include": ["src"],
+  "exclude": ["**/*.test.tsx"],
+  "compilerOptions": {
+    "outDir": "./dist"
+  }
+}
diff --git a/tsconfig.eslint.json b/tsconfig.eslint.json
@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig",
+  "include": ["src", "*.ts", "*.js"]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,21 @@
+{
+  "include": ["src"],
+  "compilerOptions": {
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "jsx": "react",
+    "moduleResolution": "Bundler",
+    "module": "ESNext",
+    "noEmit": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "strict": true
+  }
+}
diff --git a/yarn.lock b/yarn.lock

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