Skip to content

Commit

Permalink
Added support config files.
Browse files Browse the repository at this point in the history
  • Loading branch information
William Troup committed Jul 8, 2024
1 parent 1f662e1 commit eea0d19
Show file tree
Hide file tree
Showing 13 changed files with 220 additions and 1,451 deletions.
7 changes: 2 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,5 @@
/.vscode
.DS_Store
*.nupkg
dist
build
node_modules
.idea
package-lock.json
/build
/node_modules
19 changes: 19 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/.github
/.vscode
/test
/build
CODE_OF_CONDUCT.md
CONTRIBUTING.md
jsontree.js.nuspec
PACK.sh
PUBLISH.sh
README_NUGET.md
SECURITY.md
SERVE.sh
package-lock.json
tsconfig.json
tsup.build.config.ts
tsup.build.esm.config.ts
tsup.build.min.config.ts
BUILD_INSTRUCTIONS.md
*.nupkg
83 changes: 83 additions & 0 deletions BUILD_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Building JsonTree.js

Before getting started with JsonTree.js, please read through the following instructions:


## Step 1: Install Packages:

Install the packages using the following NPM commands:

### 1. Install TypeScript:

```markdown
npm install -g typescript
```

### 2. Install tsup:

```markdown
npm i tsup -D
```

### 3. Install terser:

```markdown
npm install terser -D
```

### 4. Install swc/core (if ES5 is required):

```markdown
npm install @swc/core -D
```


## Step 2: Build Project:

### 1. Full Build:

To build the TypeScript, run the following command:

```markdown
npm run build-typescript
```

To build the SASS, run the following command:

```markdown
npm run build-sass
```

To build the everything, run the following command:

```markdown
npm run build
```

### 2. Minimized Build:

To build the TypeScript, run the following command:

```markdown
npm run build-minimized-typescript
```

To build the SASS, run the following command:

```markdown
npm run build-minimized-sass
```

To build the everything, run the following command:

```markdown
npm run build-minimized
```

### 3. ESM Build:

To build the TypeScript, run the following command:

```markdown
npm run build-typescript-esm
```
22 changes: 0 additions & 22 deletions biome.json

This file was deleted.

1 change: 0 additions & 1 deletion src/constants.ts

This file was deleted.

Loading

0 comments on commit eea0d19

Please sign in to comment.