Skip to content

Commit 1bba36c

Browse files
committed
chore(package): re-export module in commonjs format
BREAKING CHANGE: remove having to use `.default` while requiring this module closes #19
1 parent a0042d3 commit 1bba36c

File tree

3 files changed

+6
-12
lines changed

3 files changed

+6
-12
lines changed

README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,16 @@
2626

2727
`npm i -D nuxt-netlify-cms netlify-cms` OR `yarn add -D nuxt-netlify-cms netlify-cms`
2828

29-
- Require `nuxt-netlify-cms` at the start of `nuxt.config.js`
30-
31-
```js
32-
var netlifyCmsModule = require("nuxt-netlify-cms").default;
33-
```
34-
35-
:information_source: Note the `.default` in the above snippet. It is mandatory for this module, written in ES6, to work properly.
36-
Please read [Misunderstanding ES6 Modules, Upgrading Babel, Tears, and a Solution](https://medium.com/@kentcdodds/misunderstanding-es6-modules-upgrading-babel-tears-and-a-solution-ad2d5ab93ce0) if you're interested to know why.
37-
3829
- Add `nuxt-netlify-cms` to `modules` section of `nuxt.config.js`
3930

4031
```js
4132
{
4233
modules: [
4334
// Simple usage
44-
netlifyCmsModule,
35+
"nuxt-netlify-cms",
4536

4637
// With options
47-
[netlifyCmsModule, { adminPath: "secure" }],
38+
["nuxt-netlify-cms", { adminPath: "secure" }],
4839
],
4940

5041
// You can optionally use global options instead of inline form

index.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
var netlifyCmsModule = require("./dist/module.js");
2+
module.exports = netlifyCmsModule.default;
3+
module.exports.meta = netlifyCmsModule.meta;

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"description": "Easy Netlify CMS integration with nuxt.js",
44
"version": "1.2.1",
55
"license": "MIT",
6-
"main": "dist/module.js",
6+
"main": "index.js",
77
"author": "Mehdi Lahlou <mehdi.lahlou@free.fr>",
88
"repository": "https://github.com/medfreeman/nuxt-netlify-cms-module.git",
99
"scripts": {

0 commit comments

Comments
 (0)