Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .prettierrc.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module.exports = {
export default {
arrowParens: 'avoid',
bracketSpacing: true,
endOfLine: 'lf',
Expand Down
43 changes: 24 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,15 @@
<br/>
<br/>

![download status][download-badge]
![version][version-badge]
![Code Coverage][coverage-badge]
![MIT License][license-badge]
![download status][download-badge] ![version][version-badge]
![Code Coverage][coverage-badge] ![MIT License][license-badge]
![semantic-release][semantic-badge]


Welcome to Toolbox! A zero-dependency 📦 tree-shakable🌲 collection of missing JavaScript utilities.
Welcome to Toolbox! A zero-dependency 📦 tree-shakable🌲 collection of missing
JavaScript utilities.

</div>



## Table of Contents <!-- omit in toc -->

<!-- cspell:disable -->
Expand Down Expand Up @@ -49,15 +45,15 @@ $ npm install --save-dev @fullstacksjs/toolbox
### Deno

```typescript
import * as toolbox from 'https://raw.githubusercontent.com/fullstacksjs/toolbox/main/mod.ts'
import * as toolbox from 'https://raw.githubusercontent.com/fullstacksjs/toolbox/main/mod.ts';
```

### Browser

```html
<script src='https://www.unpkg.com/@fullstacksjs/toolbox/iife/index.js'></script>
<script src="https://unpkg.com/@fullstacksjs/toolbox"></script>
<script>
console.log(window.Toolbox)
console.log(window.Toolbox);
</script>
```

Expand All @@ -72,16 +68,19 @@ Development of toolbox happens in GitHub, and we appreciate contributions.

### Pull Request

The FullstacksJS team is monitoring for pull requests. We will go ahead and review your pull request as soon as possible.
The FullstacksJS team is monitoring for pull requests. We will go ahead and
review your pull request as soon as possible.

Before submitting a pull request, please make sure the following is done:

- Fork the repository and create your feature branch from dev.
- Run `npm install` to have all dependencies.
- To start development run `npm run test:watch`.
- Write tests in `src/<scope>/<name>.spec.ts` and implementation in `src/<scope>/<name>.ts`.
- Write tests in `src/<scope>/<name>.spec.ts` and implementation in
`src/<scope>/<name>.ts`.
- Add JSDoc for you function with signature and examples.
- Add the documentation using [doc template](./docs/DOC-TEMPLATE.mdx) page to the `docs/<scope>/<function>.mdx` and update `docs/<scope>/_meta.json` file.
- Add the documentation using [doc template](./docs/DOC-TEMPLATE.mdx) page to
the `docs/<scope>/<function>.mdx` and update `docs/<scope>/_meta.json` file.
- Ensure everything is ok `npm run verify`.

## Code of Conduct
Expand All @@ -92,10 +91,16 @@ Before submitting a pull request, please make sure the following is done:

Please check out the [documentation page](https://toolbox.fullstacksjs.com)

[download-badge]: https://img.shields.io/npm/dm/@fullstacksjs/toolbox?color=EF6969&label=DOWNLOADS&style=flat-square
[version-badge]: https://img.shields.io/npm/v/@fullstacksjs/toolbox?color=098FAA&label=VERSION&style=flat-square
[coverage-badge]: https://raw.githubusercontent.com/fullstacksjs/toolbox/assets/assets/coverage.svg
[license-badge]: https://img.shields.io/npm/l/@fullstacksjs/toolbox?color=EA5F12&label=LICENSE&style=flat-square
[semantic-badge]: https://img.shields.io/badge/semantic-release-e10079.svg?logo=semantic-release&color=7E98F7&label=SEMANTIC&style=flat-square (https://github.com/semantic-release/semantic-release)
[download-badge]:
https://img.shields.io/npm/dm/@fullstacksjs/toolbox?color=EF6969&label=DOWNLOADS&style=flat-square
[version-badge]:
https://img.shields.io/npm/v/@fullstacksjs/toolbox?color=098FAA&label=VERSION&style=flat-square
[coverage-badge]:
https://raw.githubusercontent.com/fullstacksjs/toolbox/assets/assets/coverage.svg
[license-badge]:
https://img.shields.io/npm/l/@fullstacksjs/toolbox?color=EA5F12&label=LICENSE&style=flat-square
[semantic-badge]:
https://img.shields.io/badge/semantic-release-e10079.svg?logo=semantic-release&color=7E98F7&label=SEMANTIC&style=flat-square
'https://github.com/semantic-release/semantic-release'
[nodejs]: https://nodejs.org/en/
[bash]: https://www.gnu.org/software/bash/
2 changes: 1 addition & 1 deletion commitlint.config.js
Original file line number Diff line number Diff line change
@@ -1 +1 @@
module.exports = { extends: ['@commitlint/config-conventional'] };
export default { extends: ['@commitlint/config-conventional'] };
2 changes: 1 addition & 1 deletion docs/pages/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ ES Module
Script

```html copy
<script src='https://www.unpkg.com/@fullstacksjs/toolbox/iife/index.js'></script>
<script src='https://unpkg.com/@fullstacksjs/toolbox'></script>
<script>
console.log(window.Toolbox)
</script>
Expand Down
1 change: 1 addition & 0 deletions keywords.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ jsdoc
unoptimized
nojekyll
treeshake
tsdown
tsup
postbuild
runtimes
Expand Down
2 changes: 1 addition & 1 deletion lint-staged.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module.exports = {
export default {
'*.md': ['cspell --no-must-find-files'],
'*.{json,yaml}': ['prettier --write', 'cspell --no-must-find-files'],
'*.{js,ts,tsx}': ['eslint --fix', 'cspell --no-must-find-files'],
Expand Down
Loading