Skip to content

Commit

Permalink
[optimize] upgrade to MobX-RESTful 2 & other latest Upstream packages
Browse files Browse the repository at this point in the history
[optimize] NPM provenance & Read Me document
  • Loading branch information
TechQuery committed Nov 10, 2024
1 parent 6cc83bc commit 3076546
Show file tree
Hide file tree
Showing 5 changed files with 530 additions and 375 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: Build & Publish
run: |
echo GITHUB_PAT=${{ secrets.PAT }} > .env
npm publish
npm publish --access public --provenance
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

Expand Down
1 change: 0 additions & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
provenance = true
auto-install-peers = false
24 changes: 10 additions & 14 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

[MobX][1] SDK for [GitHub RESTful API][2], which is based on [MobX-RESTful][3].

[![MobX compatibility](https://img.shields.io/badge/Compatible-1?logo=mobx&label=MobX%206%2F7)][4]
[![NPM Dependency](https://img.shields.io/librariesio/release/npm/mobx-github)][5]
[![CI & CD](https://github.com/idea2app/MobX-GitHub/actions/workflows/main.yml/badge.svg)][6]
[![MobX compatibility](https://img.shields.io/badge/Compatible-1?logo=mobx&label=MobX%206%2F7)][1]
[![NPM Dependency](https://img.shields.io/librariesio/release/npm/mobx-github)][4]
[![CI & CD](https://github.com/idea2app/MobX-GitHub/actions/workflows/main.yml/badge.svg)][5]

[![NPM](https://nodei.co/npm/mobx-github.png?downloads=true&downloadRank=true&stars=true)][7]
[![NPM](https://nodei.co/npm/mobx-github.png?downloads=true&downloadRank=true&stars=true)][6]

## Model

Expand All @@ -25,9 +25,6 @@
npm i mobx-github
```

> Some **Node.js** tips about the upstream `mobx-restful` you should know:
> https://github.com/idea2app/MobX-RESTful?tab=readme-ov-file#usage
### `tsconfig.json`

```json
Expand Down Expand Up @@ -65,12 +62,12 @@ export const userStore = new UserModel();

### `page/GitHub.tsx`

Use [WebCell][8] as an Example
Use [WebCell][7] as an Example

```tsx
import { component, observer } from 'web-cell';

import { userStore, organizationStore, repositoryStore } from '../model/GitHub';
import { userStore } from '../model/GitHub';

@component({ tagName: 'github-page' })
@observer
Expand Down Expand Up @@ -100,8 +97,7 @@ export class GitHubPage extends HTMLElement {
[1]: https://mobx.js.org/
[2]: https://docs.github.com/en/rest
[3]: https://github.com/idea2app/MobX-RESTful
[4]: https://mobx.js.org/
[5]: https://libraries.io/npm/mobx-github
[6]: https://github.com/idea2app/MobX-GitHub/actions/workflows/main.yml
[7]: https://nodei.co/npm/mobx-github/
[8]: https://github.com/EasyWebApp/WebCell
[4]: https://libraries.io/npm/mobx-github
[5]: https://github.com/idea2app/MobX-GitHub/actions/workflows/main.yml
[6]: https://nodei.co/npm/mobx-github/
[7]: https://github.com/EasyWebApp/WebCell
16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mobx-github",
"version": "0.3.4",
"version": "0.3.5",
"license": "LGPL-3.0-or-later",
"author": "[email protected]",
"description": "MobX SDK for GitHub RESTful API, which is based on MobX-RESTful.",
Expand All @@ -27,25 +27,25 @@
"dependencies": {
"@octokit/openapi-types": "^22.2.0",
"@swc/helpers": "^0.5.13",
"@types/lodash": "^4.17.7",
"@types/lodash": "^4.17.13",
"koajax": ">=0.9 <4",
"lodash": "^4.17.21",
"mobx": ">=6.11",
"mobx-restful": ">=0.7.0-rc.0 <2",
"web-utility": "^4.4.0"
"mobx-restful": ">=0.7.0-rc.0 <3",
"web-utility": "^4.4.2"
},
"devDependencies": {
"@parcel/config-default": "~2.12.0",
"@parcel/packager-ts": "~2.12.0",
"@parcel/transformer-typescript-tsc": "~2.12.0",
"@parcel/transformer-typescript-types": "~2.12.0",
"husky": "^9.1.5",
"husky": "^9.1.6",
"lint-staged": "^15.2.10",
"parcel": "~2.12.0",
"prettier": "^3.3.3",
"typedoc": "^0.26.6",
"typedoc-plugin-mdn-links": "^3.2.11",
"typescript": "~5.5.4"
"typedoc": "^0.26.11",
"typedoc-plugin-mdn-links": "^3.3.7",
"typescript": "~5.6.3"
},
"prettier": {
"singleQuote": true,
Expand Down
Loading

0 comments on commit 3076546

Please sign in to comment.