1.0.0 ā€¢ Published 11 months ago

concat-with-sourcemap v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

npm Build Status Sonar Quality Gate bundle size

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 šŸ”§

Installation šŸ“¦

pnpm i concat-with-sourcemap
// or
yarn add concat-with-sourcemap
// or
npm i concat-with-sourcemap

Usage Example šŸš€

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 - linkedin

Project Link: https://github.com/LoaderB0T/awesome-logging