diff --git a/README.md b/README.md index e7d413b2..b570db60 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,6 @@ All packages follow the same format `@waveshq/standard-(platform)-*`. All depend with the same version tag. | Package | Type | Description | -|------------------------------|-------------|------------------------------------------------------------------------------------| +| ---------------------------- | ----------- | ---------------------------------------------------------------------------------- | | @waveshq/standard-web | Boilerplate | Boilerplate for easier scaffolding of web projects. (Next.js + React + TypeScript) | | @waveshq/standard-web-linter | Linting | Standardized eslint and prettier config for Web based on Next.js rules. | diff --git a/packages/standard-web/README.md b/packages/standard-web/README.md index 013f9fdf..5c075d32 100644 --- a/packages/standard-web/README.md +++ b/packages/standard-web/README.md @@ -8,10 +8,10 @@ Standard web tools for scaffolding web applications. Our choice of framework is This package also includes a `tsconfig.json` which is customized for web usage. -Packages that are included are based on the requirements of Next.js to avoid version mismatch. +Packages that are included are based on the requirements of Next.js to avoid version mismatch. | Package | Description | -|------------|--------------------------------------------------| +| ---------- | ------------------------------------------------ | | next | Used as the base library. | | react | Fixes the react version required by Next.js | | react-dom | Fixes the react version required by Next.js | diff --git a/packages/standard-web/tsconfig.json b/packages/standard-web/tsconfig.json index e26b8082..23bd8880 100644 --- a/packages/standard-web/tsconfig.json +++ b/packages/standard-web/tsconfig.json @@ -3,11 +3,7 @@ "display": "Default", "compilerOptions": { "target": "es5", - "lib": [ - "dom", - "dom.iterable", - "esnext" - ], + "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, "strict": false, @@ -23,39 +19,16 @@ "incremental": true, "baseUrl": "src", "paths": { - "@content/*": [ - "../content/*" - ], - "@api/*": [ - "api/*" - ], - "@contexts/*": [ - "layouts/contexts/*" - ], - "@components/*": [ - "components/*" - ], - "@hooks/*": [ - "hooks/*" - ], - "@store/*": [ - "store/*" - ], - "@utils/*": [ - "utils/*" - ], - "@public/*": [ - "../public/*" - ] + "@content/*": ["../content/*"], + "@api/*": ["api/*"], + "@contexts/*": ["layouts/contexts/*"], + "@components/*": ["components/*"], + "@hooks/*": ["hooks/*"], + "@store/*": ["store/*"], + "@utils/*": ["utils/*"], + "@public/*": ["../public/*"] } }, - "include": [ - "next-env.d.ts", - "**/*.ts", - "**/*.tsx" - ], - "exclude": [ - "node_modules", - "cypress" - ] + "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"], + "exclude": ["node_modules", "cypress"] }