Skip to content

Commit

Permalink
feat: 👷 build commands
Browse files Browse the repository at this point in the history
  • Loading branch information
mfbevan committed Sep 28, 2023
1 parent bfba691 commit 79d373b
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 14 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
<a href="https://bun.sh"><img src="https://user-images.githubusercontent.com/709451/182802334-d9c42afe-f35d-4a7b-86ea-9985f73f20c3.png" alt="Logo" height=170></a>
</p>


Welcome to the Bun project template repository! This template provides a starting point for creating new projects using [bun](https://bun.sh/). With bun, you can quickly build modern JavaScript and TypeScript applications.

## Features
Expand Down Expand Up @@ -47,34 +46,36 @@ Start building your Bun project by modifying the index.ts file and adding your a
### Linting

To lint your code:

```
bun lint
```

### Tesing
### Testing

To run tests:

```
bun test
```


## Directory Structure

The project template follows a typical directory structure for Bun projects:

- `index.ts`: The entry point for your application.
src/: Directory for your application source code.
tests/: Directory for your tests.
src/: Directory for your application source code.
tests/: Directory for your tests.
- `.eslintrc.cjs`: ESLint configuration file.
- `package.json`: Project configuration, including scripts and dependencies.
- `/modules`: Contains the modules you are creating
- `/types`: Contains TypeScript types that are shared across your repository
- `/test`: Contains tests for the modules you have created


## Contributing

If you have suggestions, bug reports, or would like to contribute to this project template, please open an issue or submit a pull request on the GitHub repository.

## License
This project is licensed under the MIT License - see the LICENSE file for details.

This project is licensed under the MIT License - see the LICENSE file for details.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"scripts": {
"start": "bun index.ts",
"test": "bun test",
"lint": "eslint . "
"lint": "eslint . ",
"build:tsc": "tsc --outDir ./dist"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^6.7.0",
Expand Down
10 changes: 10 additions & 0 deletions tsconfig.build.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"baseUrl": ".",
"outDir": "dist",
"declarationDir": "dist/types"
},
"include": ["index.ts"],
"exclude": ["node_modules", "dist"]
}
13 changes: 7 additions & 6 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
"moduleResolution": "bundler",
"moduleDetection": "force",
"allowImportingTsExtensions": true,
"noEmit": true,
"emitDeclarationOnly": true,
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"declaration": true,
"composite": true,
"strict": true,
"downlevelIteration": true,
Expand All @@ -16,9 +19,7 @@
"allowJs": true,
"types": [
"bun-types" // add Bun global
],
"paths": {
"@/*": ["./*"]
}
}
]
},
"exclude": ["node_modules", "dist"]
}

0 comments on commit 79d373b

Please sign in to comment.