https://github.com/reactioncommerce/reekwire

Workaround for using CommonJS named exports in ES modules.
https://github.com/reactioncommerce/reekwire

Last synced: about 2 months ago
JSON representation

Workaround for using CommonJS named exports in ES modules.

• Host: GitHub
• URL: https://github.com/reactioncommerce/reekwire
• Owner: reactioncommerce
• License: apache-2.0
• Created: 2020-01-29T21:51:16.000Z (almost 5 years ago)
• Default Branch: trunk
• Last Pushed: 2024-06-16T10:38:47.000Z (7 months ago)
• Last Synced: 2024-08-21T09:15:18.078Z (4 months ago)
• Language: JavaScript
• Size: 518 KB
• Stars: 3
• Watchers: 13
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# reekwire

Workaround for using CommonJS named exports in ES modules.

## Overview

In order to import named CommonJS exports inside ES modules, you currently need to employ a [workaround](https://nodejs.org/api/modules.html#modules_module_createrequire_filename).

This project simplifies the workaround, wrapping it up into one package.

## Usage

```

import require from "reekwire";

const { registerSchema } = require("@reactioncommerce/schemas");

```

Also works to import JSON files which were supported with CommonJS's `require` function:

```

import require from "reekwire";

const pkg = require("./package.json");

console.log(`${pkg.name}@${pkg.version}`);

```

## Commit Messages

To ensure that all contributors follow the correct message convention, each time you commit your message will be validated with the [commitlint](https://www.npmjs.com/package/@commitlint/cli) package, enabled by the [husky](https://www.npmjs.com/package/husky) Git hooks manager.

Examples of commit messages: https://github.com/semantic-release/semantic-release

## Publication to NPM

The `@reactioncommerce/migrator` package is automatically published by CI when commits are merged or pushed to the `master` branch. This is done using [semantic-release](https://www.npmjs.com/package/semantic-release), which also determines version bumps based on conventional Git commit messages.

## Developer Certificate of Origin

We use the [Developer Certificate of Origin (DCO)](https://developercertificate.org/) in lieu of a Contributor License Agreement for all contributions to Reaction Commerce open source projects. We request that contributors agree to the terms of the DCO and indicate that agreement by signing all commits made to Reaction Commerce projects by adding a line with your name and email address to every Git commit message contributed:

```

Signed-off-by: Jane Doe 

```

You can sign your commit automatically with Git by using `git commit -s` if you have your `user.name` and `user.email` set as part of your Git configuration.

We ask that you use your real name (please no anonymous contributions or pseudonyms). By signing your commit you are certifying that you have the right have the right to submit it under the open source license used by that particular Reaction Commerce project. You must use your real name (no pseudonyms or anonymous contributions are allowed.)

We use the [Probot DCO GitHub app](https://github.com/apps/dco) to check for DCO signoffs of every commit.

If you forget to sign your commits, the DCO bot will remind you and give you detailed instructions for how to amend your commits to add a signature.

## License

   Copyright 2020 Reaction Commerce

   Licensed under the Apache License, Version 2.0 (the "License");

   you may not use this file except in compliance with the License.

   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software

   distributed under the License is distributed on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   See the License for the specific language governing permissions and

   limitations under the License.