feat: improve contribution docs and add source maps to build (#237)

This commit is contained in:
Mildred Ki'Lya 2022-12-15 16:40:02 +01:00 committed by GitHub
parent ca87869210
commit 7d6275d83a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 0 deletions

View File

@ -17,6 +17,8 @@ For details on contributing to documentation, see [Website Directory Readme](htt
git clone https://github.com/StaticJsCMS/static-cms git clone https://github.com/StaticJsCMS/static-cms
cd static-cms cd static-cms
yarn yarn
cd core
yarn
``` ```
### Run core locally ### Run core locally
@ -24,6 +26,7 @@ yarn
> In `core` directory > In `core` directory
```sh ```sh
cd core # if not there already
yarn start yarn start
``` ```
@ -34,6 +37,7 @@ yarn start
Starts the development server. This task runs both the `clean` and `develop` scripts. Starts the development server. This task runs both the `clean` and `develop` scripts.
```sh ```sh
cd core # if not there already
yarn start yarn start
``` ```
@ -42,6 +46,7 @@ yarn start
Removes the `dist` directory. Removes the `dist` directory.
```sh ```sh
cd core # if not there already
yarn clean yarn clean
``` ```
@ -50,6 +55,7 @@ yarn clean
Runs the `clean` script and builds the @static-cms/core. Runs the `clean` script and builds the @static-cms/core.
```sh ```sh
cd core # if not there already
yarn build yarn build
``` ```
@ -58,6 +64,7 @@ yarn build
Formats code and docs according to our style guidelines. Formats code and docs according to our style guidelines.
```sh ```sh
cd core # if not there already
yarn format yarn format
``` ```

View File

@ -1,5 +1,6 @@
{ {
"compilerOptions": { "compilerOptions": {
"sourceMap": true,
"declaration": true, "declaration": true,
"declarationDir": "dist", "declarationDir": "dist",
"emitDeclarationOnly": true, "emitDeclarationOnly": true,

View File

@ -13,6 +13,7 @@ function moduleNameToPath(libName) {
module.exports = { module.exports = {
entry: './src/index.ts', entry: './src/index.ts',
mode: isProduction ? 'production' : 'development', mode: isProduction ? 'production' : 'development',
devtool: 'source-map',
module: { module: {
rules: [ rules: [
{ {