mirror of
https://github.com/t4t5/nostr-react.git
synced 2025-03-17 13:31:43 +01:00
feat: first commit(by dts)
This commit is contained in:
commit
41c531e4f8
1
.gitattributes
vendored
Normal file
1
.gitattributes
vendored
Normal file
@ -0,0 +1 @@
|
||||
* text eol=lf
|
32
.github/workflows/main.yml
vendored
Normal file
32
.github/workflows/main.yml
vendored
Normal file
@ -0,0 +1,32 @@
|
||||
name: CI
|
||||
on: [push]
|
||||
jobs:
|
||||
build:
|
||||
name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
|
||||
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
node: ['14.x', '16.x']
|
||||
os: [ubuntu-latest, windows-latest, macOS-latest]
|
||||
|
||||
steps:
|
||||
- name: Checkout repo
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Use Node ${{ matrix.node }}
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: ${{ matrix.node }}
|
||||
|
||||
- name: Install deps and build (with cache)
|
||||
uses: bahmutov/npm-install@v1
|
||||
|
||||
- name: Lint
|
||||
run: yarn lint
|
||||
|
||||
- name: Test
|
||||
run: yarn test --ci --coverage --maxWorkers=2
|
||||
|
||||
- name: Build
|
||||
run: yarn build
|
12
.github/workflows/size.yml
vendored
Normal file
12
.github/workflows/size.yml
vendored
Normal file
@ -0,0 +1,12 @@
|
||||
name: size
|
||||
on: [pull_request]
|
||||
jobs:
|
||||
size:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
CI_JOB_NUMBER: 1
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: andresz1/size-limit-action@v1
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
5
.gitignore
vendored
Normal file
5
.gitignore
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
*.log
|
||||
.DS_Store
|
||||
node_modules
|
||||
.cache
|
||||
dist
|
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2022 Tristan Edwards
|
||||
|
||||
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.
|
160
README.md
Normal file
160
README.md
Normal file
@ -0,0 +1,160 @@
|
||||
# DTS React User Guide
|
||||
|
||||
Congrats! You just saved yourself hours of work by bootstrapping this project with DTS. Let’s get you oriented with what’s here and how to use it.
|
||||
|
||||
> This DTS setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
|
||||
|
||||
> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
|
||||
|
||||
## Commands
|
||||
|
||||
DTS scaffolds your new library inside `/src`, and also sets up a [Vite-based](https://vitejs.dev) playground for it inside `/example`.
|
||||
|
||||
The recommended workflow is to run DTS in one terminal:
|
||||
|
||||
```bash
|
||||
npm start # or yarn start
|
||||
```
|
||||
|
||||
This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
|
||||
|
||||
Then run the example inside another:
|
||||
|
||||
```bash
|
||||
cd example
|
||||
npm i # or yarn to install dependencies
|
||||
npm start # or yarn start
|
||||
```
|
||||
|
||||
The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure DTS is running in watch mode like we recommend above.
|
||||
|
||||
To do a one-off build, use `npm run build` or `yarn build`.
|
||||
|
||||
To run tests, use `npm test` or `yarn test`.
|
||||
|
||||
## Configuration
|
||||
|
||||
Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
|
||||
|
||||
### Jest
|
||||
|
||||
Jest tests are set up to run with `npm test` or `yarn test`.
|
||||
|
||||
### Bundle analysis
|
||||
|
||||
Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.
|
||||
|
||||
#### Setup Files
|
||||
|
||||
This is the folder structure we set up for you:
|
||||
|
||||
```txt
|
||||
/example
|
||||
index.html
|
||||
index.tsx # test your component here in a demo app
|
||||
package.json
|
||||
tsconfig.json
|
||||
/src
|
||||
index.tsx # EDIT THIS
|
||||
/test
|
||||
index.test.tsx # EDIT THIS
|
||||
.gitignore
|
||||
package.json
|
||||
README.md # EDIT THIS
|
||||
tsconfig.json
|
||||
```
|
||||
|
||||
#### React Testing Library
|
||||
|
||||
We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
|
||||
|
||||
### Rollup
|
||||
|
||||
DTS uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
|
||||
|
||||
### TypeScript
|
||||
|
||||
`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
|
||||
|
||||
## Continuous Integration
|
||||
|
||||
### GitHub Actions
|
||||
|
||||
Two actions are added by default:
|
||||
|
||||
- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
|
||||
- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
|
||||
|
||||
## Optimizations
|
||||
|
||||
Please see the main `dts` [optimizations docs](https://github.com/weiran-zsd/dts-cli#optimizations). In particular, know that you can take advantage of development-only optimizations:
|
||||
|
||||
```js
|
||||
// ./types/index.d.ts
|
||||
declare var __DEV__: boolean;
|
||||
|
||||
// inside your code...
|
||||
if (__DEV__) {
|
||||
console.log('foo');
|
||||
}
|
||||
```
|
||||
|
||||
You can also choose to install and use [invariant](https://github.com/weiran-zsd/dts-cli#invariant) and [warning](https://github.com/weiran-zsd/dts-cli#warning) functions.
|
||||
|
||||
## Module Formats
|
||||
|
||||
CJS, ESModules, and UMD module formats are supported.
|
||||
|
||||
The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
|
||||
|
||||
## Deploying the Example Playground
|
||||
|
||||
The Playground is just a simple [Vite](https://vitejs.dev) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
|
||||
|
||||
```bash
|
||||
cd example # if not already in the example folder
|
||||
npm run build # builds to dist
|
||||
netlify deploy # deploy the dist folder
|
||||
```
|
||||
|
||||
Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
|
||||
|
||||
```bash
|
||||
netlify init
|
||||
# build command: yarn build && cd example && yarn && yarn build
|
||||
# directory to deploy: example/dist
|
||||
# pick yes for netlify.toml
|
||||
```
|
||||
|
||||
## Named Exports
|
||||
|
||||
Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
|
||||
|
||||
## Including Styles
|
||||
|
||||
There are many ways to ship styles, including with CSS-in-JS. DTS has no opinion on this, configure how you like.
|
||||
|
||||
For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
|
||||
|
||||
## Publishing to NPM
|
||||
|
||||
We recommend using [np](https://github.com/sindresorhus/np).
|
||||
|
||||
## Usage with Lerna
|
||||
|
||||
When creating a new package with DTS within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.
|
||||
|
||||
The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's `package.json` might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.
|
||||
|
||||
Change the `alias` to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.
|
||||
|
||||
```diff
|
||||
"alias": {
|
||||
- "react": "../node_modules/react",
|
||||
- "react-dom": "../node_modules/react-dom"
|
||||
+ "react": "../../../node_modules/react",
|
||||
+ "react-dom": "../../../node_modules/react-dom"
|
||||
},
|
||||
```
|
||||
|
||||
An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. [However, that might cause other problems.](https://github.com/formium/tsdx/issues/64)
|
14
example/index.html
Normal file
14
example/index.html
Normal file
@ -0,0 +1,14 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
|
||||
<title>Playground</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="root"></div>
|
||||
<script type="module" src="./index.tsx"></script>
|
||||
</body>
|
||||
</html>
|
14
example/index.tsx
Normal file
14
example/index.tsx
Normal file
@ -0,0 +1,14 @@
|
||||
import 'react-app-polyfill/ie11';
|
||||
import * as React from 'react';
|
||||
import * as ReactDOM from 'react-dom';
|
||||
import { Thing } from '../.';
|
||||
|
||||
const App = () => {
|
||||
return (
|
||||
<div>
|
||||
<Thing />
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
ReactDOM.render(<App />, document.getElementById('root'));
|
26
example/package.json
Normal file
26
example/package.json
Normal file
@ -0,0 +1,26 @@
|
||||
{
|
||||
"name": "example",
|
||||
"private": true,
|
||||
"version": "1.0.0",
|
||||
"main": "index.js",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"start": "vite",
|
||||
"build": "vite build"
|
||||
},
|
||||
"dependencies": {
|
||||
"react-app-polyfill": "^3.0.0"
|
||||
},
|
||||
"alias": {
|
||||
"react": "../node_modules/react",
|
||||
"react-dom": "../node_modules/react-dom/profiling",
|
||||
"scheduler/tracing": "../node_modules/scheduler/tracing-profiling"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/react": "^17.0.47",
|
||||
"@types/react-dom": "^17.0.17",
|
||||
"vite": "latest",
|
||||
"vite-preset-react": "latest",
|
||||
"typescript": "^4"
|
||||
}
|
||||
}
|
3
example/tsconfig.json
Normal file
3
example/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "@tsconfig/create-react-app/tsconfig.json"
|
||||
}
|
11
example/vite.config.js
Normal file
11
example/vite.config.js
Normal file
@ -0,0 +1,11 @@
|
||||
import { defineConfig } from 'vite';
|
||||
import ReactPlugin from 'vite-preset-react';
|
||||
|
||||
// https://vitejs.dev/config/
|
||||
export default defineConfig({
|
||||
plugins: [
|
||||
ReactPlugin({
|
||||
injectReact: false,
|
||||
}),
|
||||
],
|
||||
});
|
52
package.json
Normal file
52
package.json
Normal file
@ -0,0 +1,52 @@
|
||||
{
|
||||
"name": "nostrgg-react",
|
||||
"version": "0.1.0",
|
||||
"license": "MIT",
|
||||
"author": "Tristan Edwards",
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/nostrgg-react.esm.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"files": [
|
||||
"dist",
|
||||
"src"
|
||||
],
|
||||
"scripts": {
|
||||
"analyze": "size-limit --why",
|
||||
"build": "dts build",
|
||||
"lint": "dts lint",
|
||||
"prepare": "dts build",
|
||||
"size": "size-limit",
|
||||
"start": "dts watch",
|
||||
"test": "dts test --passWithNoTests"
|
||||
},
|
||||
"husky": {
|
||||
"hooks": {
|
||||
"pre-commit": "dts lint"
|
||||
}
|
||||
},
|
||||
"prettier": {
|
||||
"printWidth": 80,
|
||||
"semi": true,
|
||||
"singleQuote": true,
|
||||
"trailingComma": "es5"
|
||||
},
|
||||
"jest": {
|
||||
"testEnvironment": "jsdom"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"react": ">=16"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=12"
|
||||
},
|
||||
"size-limit": [
|
||||
{
|
||||
"path": "dist/nostrgg-react.cjs.production.min.js",
|
||||
"limit": "10 KB"
|
||||
},
|
||||
{
|
||||
"path": "dist/nostrgg-react.esm.js",
|
||||
"limit": "10 KB"
|
||||
}
|
||||
]
|
||||
}
|
6
src/index.tsx
Normal file
6
src/index.tsx
Normal file
@ -0,0 +1,6 @@
|
||||
import * as React from 'react';
|
||||
|
||||
// Delete me
|
||||
export const Thing = () => {
|
||||
return <div>Welcome to your first test package.</div>;
|
||||
};
|
11
test/index.test.tsx
Normal file
11
test/index.test.tsx
Normal file
@ -0,0 +1,11 @@
|
||||
import * as React from 'react';
|
||||
import * as ReactDOM from 'react-dom';
|
||||
import { Thing } from '../src/index';
|
||||
|
||||
describe('Thing', () => {
|
||||
it('renders without crashing', () => {
|
||||
const div = document.createElement('div');
|
||||
ReactDOM.render(<Thing />, div);
|
||||
ReactDOM.unmountComponentAtNode(div);
|
||||
});
|
||||
});
|
5
tsconfig.json
Normal file
5
tsconfig.json
Normal file
@ -0,0 +1,5 @@
|
||||
{
|
||||
// see https://www.typescriptlang.org/tsconfig to better understand tsconfigs
|
||||
"extends": "@tsconfig/create-react-app/tsconfig.json",
|
||||
"include": ["src", "types"],
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user