Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Commit

Permalink
chore: de-template repository
Browse files Browse the repository at this point in the history
  • Loading branch information
ccharly committed Apr 17, 2024
1 parent 02c239a commit d8c7104
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 82 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Lines starting with '#' are comments.
# Each line is a file pattern followed by one or more owners.

* @MetaMask/engineering
* @MetaMask/accounts-engineers
8 changes: 0 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,3 @@ Are there any issues or other links reviewers should consult to understand this
* Fixes #12345
* See: #67890
-->

## Examples

<!--
Are there any examples of this change being used in another repository?
When considering changes to the MetaMask module template, it's strongly preferred that the change be experimented with in another repository first. This gives reviewers a better sense of how the change works, making it less likely the change will need to be reverted or adjusted later.
-->
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

[Unreleased]: https://github.com/MetaMask/metamask-module-template/
[Unreleased]: https://github.com/MetaMask/chain-api/
34 changes: 4 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,20 @@

This TypeScript module is maintained in the style of the MetaMask team.

## Template Instructions

Follow these instructions when using this template.

- Update the package name, referenced in the following places:
- The `name` field of `package.json`
- The README title
- The README "Usage" section
- Update the package description
- The package description is referenced at the beginning of the README, and in the `description` field of `package.json`.
- Update the repository URL, referenced in the following places:
- `repository` field of `package.json`
- The links in the API section of the README
- If your project has side effects, update the `sideEffects` field of
`package.json` to `true`, or an array of file globs that match the files that
have side effects.
- Update the pull request template (`.github/pull_request_template.md`) to remove the `Examples` section that is specific to this template.
- Update the README "Usage" section, or remove it if it's not needed.
- Update the CODEOWNERS file to set the appropriate code owners for the repository (typically one or more engineering teams)
- Ensure each referenced team has write permission, and that the engineering team still has write permission.
- Delete these instructions.

## Installation

`yarn add @metamask/metamask-module-template`
`yarn add @metamask/chain-api`

or

`npm install @metamask/metamask-module-template`

## Usage

_Add examples here_
`npm install @metamask/chain-api`

## API

See our documentation:

- [Latest published API documentation](https://metamask.github.io/metamask-module-template/latest/)
- [Latest development API documentation](https://metamask.github.io/metamask-module-template/staging/)
- [Latest published API documentation](https://metamask.github.io/chain-api/latest/)
- [Latest development API documentation](https://metamask.github.io/chain-api/staging/)

## Contributing

Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@metamask/metamask-module-template",
"name": "@metamask/chain-api",
"version": "0.0.0",
"description": "The MetaMask Node module template",
"homepage": "https://github.com/MetaMask/metamask-module-template#readme",
"description": "The MetaMask chain-agnostic API",
"homepage": "https://github.com/MetaMask/chain-api#readme",
"bugs": {
"url": "https://github.com/MetaMask/metamask-module-template/issues"
"url": "https://github.com/MetaMask/chain-api/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/MetaMask/metamask-module-template.git"
"url": "https://github.com/MetaMask/chain-api.git"
},
"sideEffects": false,
"exports": {
Expand Down
74 changes: 37 additions & 37 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1047,6 +1047,43 @@ __metadata:
languageName: node
linkType: hard

"@metamask/chain-api@workspace:.":
version: 0.0.0-use.local
resolution: "@metamask/chain-api@workspace:."
dependencies:
"@lavamoat/allow-scripts": "npm:^3.0.0"
"@lavamoat/preinstall-always-fail": "npm:^2.0.0"
"@metamask/auto-changelog": "npm:^3.4.3"
"@metamask/eslint-config": "npm:^12.2.0"
"@metamask/eslint-config-jest": "npm:^12.1.0"
"@metamask/eslint-config-nodejs": "npm:^12.1.0"
"@metamask/eslint-config-typescript": "npm:^12.1.0"
"@types/jest": "npm:^28.1.6"
"@types/node": "npm:^16"
"@typescript-eslint/eslint-plugin": "npm:^5.43.0"
"@typescript-eslint/parser": "npm:^5.43.0"
"@yarnpkg/types": "npm:^4.0.0-rc.52"
depcheck: "npm:^1.4.3"
eslint: "npm:^8.44.0"
eslint-config-prettier: "npm:^8.8.0"
eslint-plugin-import: "npm:~2.26.0"
eslint-plugin-jest: "npm:^27.2.2"
eslint-plugin-jsdoc: "npm:^39.9.1"
eslint-plugin-n: "npm:^15.7.0"
eslint-plugin-prettier: "npm:^4.2.1"
eslint-plugin-promise: "npm:^6.1.1"
jest: "npm:^28.1.3"
jest-it-up: "npm:^2.0.2"
prettier: "npm:^2.7.1"
prettier-plugin-packagejson: "npm:^2.3.0"
ts-jest: "npm:^28.0.7"
ts-node: "npm:^10.7.0"
tsup: "npm:^7.2.0"
typedoc: "npm:^0.23.15"
typescript: "npm:~4.8.4"
languageName: unknown
linkType: soft

"@metamask/eslint-config-jest@npm:^12.1.0":
version: 12.1.0
resolution: "@metamask/eslint-config-jest@npm:12.1.0"
Expand Down Expand Up @@ -1097,43 +1134,6 @@ __metadata:
languageName: node
linkType: hard

"@metamask/metamask-module-template@workspace:.":
version: 0.0.0-use.local
resolution: "@metamask/metamask-module-template@workspace:."
dependencies:
"@lavamoat/allow-scripts": "npm:^3.0.0"
"@lavamoat/preinstall-always-fail": "npm:^2.0.0"
"@metamask/auto-changelog": "npm:^3.4.3"
"@metamask/eslint-config": "npm:^12.2.0"
"@metamask/eslint-config-jest": "npm:^12.1.0"
"@metamask/eslint-config-nodejs": "npm:^12.1.0"
"@metamask/eslint-config-typescript": "npm:^12.1.0"
"@types/jest": "npm:^28.1.6"
"@types/node": "npm:^16"
"@typescript-eslint/eslint-plugin": "npm:^5.43.0"
"@typescript-eslint/parser": "npm:^5.43.0"
"@yarnpkg/types": "npm:^4.0.0-rc.52"
depcheck: "npm:^1.4.3"
eslint: "npm:^8.44.0"
eslint-config-prettier: "npm:^8.8.0"
eslint-plugin-import: "npm:~2.26.0"
eslint-plugin-jest: "npm:^27.2.2"
eslint-plugin-jsdoc: "npm:^39.9.1"
eslint-plugin-n: "npm:^15.7.0"
eslint-plugin-prettier: "npm:^4.2.1"
eslint-plugin-promise: "npm:^6.1.1"
jest: "npm:^28.1.3"
jest-it-up: "npm:^2.0.2"
prettier: "npm:^2.7.1"
prettier-plugin-packagejson: "npm:^2.3.0"
ts-jest: "npm:^28.0.7"
ts-node: "npm:^10.7.0"
tsup: "npm:^7.2.0"
typedoc: "npm:^0.23.15"
typescript: "npm:~4.8.4"
languageName: unknown
linkType: soft

"@nodelib/fs.scandir@npm:2.1.5":
version: 2.1.5
resolution: "@nodelib/fs.scandir@npm:2.1.5"
Expand Down

0 comments on commit d8c7104

Please sign in to comment.