@planetscale/vtadmin
Advanced tools
Comparing version 0.1.0 to 1.0.0
{ | ||
"files": { | ||
"main.css": "/static/css/main.8ba877f1.css", | ||
"main.js": "/static/js/main.8b127340.js", | ||
"main.js": "/static/js/main.0f67bf25.js", | ||
"static/media/gear.svg": "/static/media/gear.506aad977db68002888275721fc5c03b.svg", | ||
@@ -69,8 +69,8 @@ "static/media/keyS.svg": "/static/media/keyS.54ae22a44c60e2110eb2f8536cd366e0.svg", | ||
"main.8ba877f1.css.map": "/static/css/main.8ba877f1.css.map", | ||
"main.8b127340.js.map": "/static/js/main.8b127340.js.map" | ||
"main.0f67bf25.js.map": "/static/js/main.0f67bf25.js.map" | ||
}, | ||
"entrypoints": [ | ||
"static/css/main.8ba877f1.css", | ||
"static/js/main.8b127340.js" | ||
"static/js/main.0f67bf25.js" | ||
] | ||
} |
{ | ||
"name": "@planetscale/vtadmin", | ||
"version": "0.1.0", | ||
"version": "1.0.0", | ||
"description": "Planetscale's internal version of vtadmin-web, packaged as an npm module. For use with vtadmin-api.", | ||
"main": "index.js", | ||
@@ -5,0 +6,0 @@ "typings": "index.d.ts", |
# VTAdmin Web | ||
VTAdmin Web is a user interface that allows Vitess users to easily manage and view state of their Vitess components. VTAdmin Web should be used with VTAdmin API (shipped within the Vitess monorepo). | ||
## Scripts | ||
``` | ||
- vtadmin | ||
- planetscale-vtadmin-scripts | ||
- index.ts // Index file that is copied into package directory as the entrypoint of npm package | ||
- scripts | ||
- createPlanetscaleVTAdmin.ts // Script to copy vtadmin's package.json and build folder into package folder | ||
- planetscale-vtadmin // Directory containing npm module @planetscale/vtadmin | ||
``` | ||
`web/vtadmin/package.json` includes a build script run by `npm run build:planetscale-vtadmin` that: | ||
1. Compiles contents of `web/vtadmin/planetscale-vtadmin-scripts` to a new directory `web/vtadmin/planetscale-vtadmin` | ||
2. Copies some contents of `web/vtadmin/package.json` to `web/vtadmin/planetscale-vtadmin` as `web/vtadmin/planetscale-vtadmin/package.json` | ||
## Release NPM Package | ||
To release new versions of the vtadmin npm package: | ||
1. Bump the version of vtadmin at `web/vtadmin/package.json` | ||
2. Run `npm run build` to compile vtadmin-web into a minified `build` folder | ||
3. Run `npm run build:planetscale-vtadmin` to create package directory for `@planetscale/vtadmin` npm module | ||
4. `cd planetscale-vtadmin` to navigate into the folder for module `@planetscale/vtadmin` | ||
5. `npm publish` to publish new version to npm | ||
## Usage | ||
@@ -64,1 +42,26 @@ ### Client-side (Rails example) | ||
``` | ||
## Scripts | ||
**File structure** | ||
``` | ||
- vtadmin | ||
- planetscale-vtadmin-scripts | ||
- index.ts // Index file that is copied into package directory as the entrypoint of npm package | ||
- README.md // README for @planetscale/vtadmin npm package | ||
- package.json // Base package.json for @planetscale/vtadmin npm package | ||
- scripts | ||
- createPlanetscaleVTAdmin.ts // Script to copy vtadmin's package.json and build folder into package folder | ||
- planetscale-vtadmin // Directory containing npm module @planetscale/vtadmin | ||
``` | ||
`web/vtadmin/package.json` includes a build script run by `npm run build:planetscale-vtadmin` that: | ||
1. Compiles contents of `web/vtadmin/planetscale-vtadmin-scripts` to a new directory `web/vtadmin/planetscale-vtadmin` | ||
## Release NPM Package | ||
To release new versions of the vtadmin npm package: | ||
1. Bump the version of vtadmin at `web/vtadmin/package.json` | ||
2. Run `npm run build` to compile vtadmin-web into a minified `build` folder | ||
3. Run `npm run build:planetscale-vtadmin` to create package directory for `@planetscale/vtadmin` npm module | ||
4. `cd planetscale-vtadmin` to navigate into the folder for module `@planetscale/vtadmin` | ||
5. `npm publish --access public` to publish new version to npm | ||
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Unidentified License
License(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Unidentified License
License(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.
Found 1 instance in 1 package
14261509
8612
0
67
1