79 lines
3.8 KiB
Markdown
79 lines
3.8 KiB
Markdown
# @gitzone/tsbundle
|
|
a bundler using rollup for painless bundling of web projects
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tsbundle)
|
|
* [gitlab.com (source)](https://gitlab.com/gitzone/tsbundle)
|
|
* [github.com (source mirror)](https://github.com/gitzone/tsbundle)
|
|
* [docs (typedoc)](https://gitzone.gitlab.io/tsbundle/)
|
|
|
|
## Status for master
|
|
|
|
Status Category | Status Badge
|
|
-- | --
|
|
GitLab Pipelines | [](https://lossless.cloud)
|
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
npm | [](https://lossless.cloud)
|
|
Snyk | [](https://lossless.cloud)
|
|
TypeScript Support | [](https://lossless.cloud)
|
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
Code Style | [](https://lossless.cloud)
|
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class intellisense.
|
|
|
|
tsbundle will bundle modern JavaScript websites in an Google Bot conformant way so things like AdSense do work.
|
|
|
|
tsbundle supports two modes of usage: CLI and API usage.
|
|
|
|
### CLI
|
|
|
|
```shell
|
|
# Note: This is code that belongs into your terminal ;)
|
|
# Install the tool for cli usage
|
|
|
|
# Globally
|
|
npm install -g @gitzone/tsbundle
|
|
|
|
# Locally for use in your pacakge.json
|
|
npm install --save-dev @gitzone/tsbundle
|
|
|
|
# then use it
|
|
tsbundle --from="./ts/index.ts" --to="dist/bundle.js"
|
|
|
|
## note you can call tsbundle without arguments. Default values are --from="./ts_web/index.ts" --to="dist_bundle/bundle.js"
|
|
## You can use --production to enable minification using terser
|
|
```
|
|
|
|
## API
|
|
|
|
You are using TypeScript, aren't you? Most of the stuff is apparent from the IDE intellisense.
|
|
|
|
```typescript
|
|
import { TsBundle } from '@gitozne/tsbundle';
|
|
|
|
const myTsBundleInstance = new TsBundle();
|
|
|
|
const run = async () => {
|
|
await myTsBundleInstance.buildTest('./from/my.ts', './to/mybundle.js');
|
|
// OR
|
|
await myTsBundleInstance.buildProduction('./from/my.ts', './to/mybundle.js');
|
|
};
|
|
```
|
|
|
|
## Contribution
|
|
|
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
|
|
[](https://maintainedby.lossless.com)
|