Skip to content

Commit

Permalink
Merge pull request #43 from Zxilly/master
Browse files Browse the repository at this point in the history
fix: no longer support legacy require
  • Loading branch information
hsluoyz authored Apr 27, 2021
2 parents c03b595 + 5b09912 commit 1dcc96c
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:

- name: Release
if: github.event_name == 'push' && github.repository == 'node-casbin/mongoose-adapter'
run: npx -p semantic-release -p @semantic-release/git -p @semantic-release/changelog semantic-release
run: npx -p semantic-release -p @semantic-release/git -p @semantic-release/changelog -p @semantic-release/commit-analyzer -p @semantic-release/release-notes-generator -p @semantic-release/release-notes-generator -p @semantic-release/changelog -p @semantic-release/git -p @semantic-release/github semantic-release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
22 changes: 22 additions & 0 deletions .releaserc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"debug": true,
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/npm",
[
"@semantic-release/changelog",
{
"changelogFile": "CHANGELOG.md"
}
],
[
"@semantic-release/git",
{
"assets": ["package.json", "CHANGELOG.md"],
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
}
],
"@semantic-release/github"
]
}
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ Require it in a place, where you are instantiating an enforcer ([read more about
```javascript
const path = require('path');
const { newEnforcer } = require('casbin');
const MongooseAdapter = require('casbin-mongoose-adapter');
const { MongooseAdapter } = require('casbin-mongoose-adapter');

// const MongooseAdapter = require('casbin-mongoose-adapter');
// You should use this in v2.x

const model = path.resolve(__dirname, './your_model.conf');
const adapter = await MongooseAdapter.newAdapter('mongodb://your_mongodb_uri:27017');
Expand All @@ -47,7 +50,7 @@ Casbin itself calls adapter methods to persist updates you made through it.
You can pass mongooose-specific options when instantiating the adapter:

```javascript
const MongooseAdapter = require('casbin-mongoose-adapter');
const { MongooseAdapter } = require('casbin-mongoose-adapter');
const adapter = await MongooseAdapter.newAdapter('mongodb://your_mongodb_uri:27017', { mongoose_options: 'here' });
```

Expand All @@ -63,7 +66,7 @@ You do not need to load all the rules for all domains to make an authorization i
For such cases, filtered adapter exists in casbin.

```javascript
const MongooseAdapter = require('casbin-mongoose-adapter');
const { MongooseAdapter } = require('casbin-mongoose-adapter');
const adapter = await MongooseAdapter.newFilteredAdapter('mongodb://your_mongodb_uri:27017');
```

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "casbin-mongoose-adapter",
"version": "2.2.3",
"version": "3.0.0",
"description": "Mongoose adapter for Casbin",
"main": "lib/cjs/index.js",
"typings": "lib/cjs/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ import {MongooseAdapter} from "./adapter";
export * from './model'
export * from './errors'
export * from './adapter'
// @ts-ignore
export = MongooseAdapter

export default MongooseAdapter
2 changes: 1 addition & 1 deletion test/helpers/helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

const path = require('path');
const { newEnforcer } = require('casbin');
const MongooseAdapter = require('../../lib/cjs');
const { MongooseAdapter } = require('../../lib/cjs');
const basicModel = path.resolve(__dirname, '../fixtures/basic_model.conf');
const basicPolicy = path.resolve(__dirname, '../fixtures/basic_policy.csv');
const rbacModel = path.resolve(__dirname, '../fixtures/rbac_model.conf');
Expand Down
2 changes: 1 addition & 1 deletion test/unit/adapter.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
// limitations under the License.

const { assert } = require('chai');
const { MongooseAdapter } = require('../../lib/cjs/adapter');
const { MongooseAdapter } = require('../../lib/cjs');

const MONGOOSE_OPTIONS = { useNewUrlParser: true, useCreateIndex: true, useUnifiedTopology: true };

Expand Down
3 changes: 2 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"declaration": true,
"downlevelIteration": true,
"allowJs": true,
"allowSyntheticDefaultImports": true
"allowSyntheticDefaultImports": true,
"esModuleInterop": true
},
"include": ["src/**/*"]
}

0 comments on commit 1dcc96c

Please sign in to comment.