Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/loaderb0t/concat-with-sourcemap

A simple tool to concatenate (or bundle) javascript files with their sourcemaps.
https://github.com/loaderb0t/concat-with-sourcemap

Last synced: 2 months ago
JSON representation

A simple tool to concatenate (or bundle) javascript files with their sourcemaps.

Awesome Lists containing this project

README 

        
[![npm](https://img.shields.io/npm/v/concat-with-sourcemap?color=%2300d26a&style=for-the-badge)](https://www.npmjs.com/package/concat-with-sourcemap)

[![Build Status](https://img.shields.io/github/actions/workflow/status/LoaderB0T/concat-with-sourcemap/build.yml?branch=main&style=for-the-badge)](https://github.com/LoaderB0T/concat-with-sourcemap/actions/workflows/build.yml)

[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/LoaderB0T_concat-with-sourcemap?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/summary/new_code?id=LoaderB0T_concat-with-sourcemap)

[![bundle size](https://img.shields.io/bundlephobia/minzip/concat-with-sourcemap?color=%23FF006F&label=Bundle%20Size&style=for-the-badge)](https://bundlephobia.com/package/concat-with-sourcemap)



# concat-with-sourcemap



A simple tool to concatenate (or bundle) javascript files with their sourcemaps.



## Motivation 💥



Often times, you want to bundle multiple javascript files into one. For example when you want to publish a web component, you might want to bundle all your source files into one file. This is where this tool comes in handy. JavaScript files can be easily concatenated, but their sourcemaps need to be adjusted accordingly. This tool does both for you.



## Features 🔥



✅ Written in TypeScript (Strongly typed)



✅ ESM & CJS exports



✅ Supports Sourcemap v3



## Built With 🔧



- [TypeScript](https://www.typescriptlang.org/)

- [source-map](https://www.npmjs.com/package/source-map)



## Installation 📦



```console

pnpm i concat-with-sourcemap

// or

yarn add concat-with-sourcemap

// or

npm i concat-with-sourcemap

```



## Usage Example 🚀



```typescript

import { ConcatWithSourcemap } from 'concat-with-sourcemap';



const concat = new ConcatWithSourcemap('my-bundle.js');



// Add custom content without source map

await concat.add(null, '// (c) 2023 awdware');



// Add a file. If the file has a sourcemap (./dist/index.js.map), it will be taken into account

await concat.addFile('./dist/index.js');



// Add a directory. All js files in this directory will be added. Sourcemaps will be taken into account

await concat.addDirectory('./dist/my-app');



// Save the bundle and the sourcemap to the given directory

// In this case, the bundle will be saved to ./dist/my-bundle.js and the sourcemap to ./dist/my-bundle.js.map

await concat.saveFiles('./dist');

```



## Contributing 🧑🏻‍💻



Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.



If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!



1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request



## License 🔑



Distributed under the MIT License. See `LICENSE.txt` for more information.



## Contact 📧



Janik Schumacher - [@LoaderB0T](https://twitter.com/LoaderB0T) - [linkedin](https://www.linkedin.com/in/janikschumacher/)



Project Link: [https://github.com/LoaderB0T/awesome-logging](https://github.com/LoaderB0T/awesome-logging)