@mappable-world/mappable-cli - npm Package Compare versions

Comparing version 0.0.1-beta.24 to 0.0.1-beta.25

package.json

 {
   "name": "@mappable-world/mappable-cli",
-  "version": "0.0.1-beta.24",
+  "version": "0.0.1-beta.25",
   "description": "Library for encapsulating the logic of autotests and building packages mappable.world js API",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

template/t_tREADME.md

@@ -5,4 +5,39 @@ # Mappable JS API Example Package
 
-```
+
+## Getting started
+
+To get started:
+
+```sh
 npm start
 ```
+
+or so if you didn't create the `.env` file
+
+```sh
+APIKEY=%APIKEY% npm start
+```
+
+To check with linter:
+
+```sh
+npm run lint
+```
+
+For the final build:
+
+```sh
+npm run build
+```
+
+## GitHub actions
+
+After you create a new tag, or just push changes to the server, ci will be launched
+
+CI described here `.github/workflows/release.yml` and `.github/workflows/tests.yml`
+
+For it to work, you need to declare two secrets in the GitHub Action:
+
+- `APIKEY` - To run autotests on the JS API https://mappable.world/docs/js-api/quickstart.html#get-api-key
+- `NPM_TOKEN` - To publish your package to npm
+

tsconfig.json

 {
     "compilerOptions": {
+        "declaration": true,
+        "declarationDir": "dist",
         "lib": ["ES2018"],
@@ -4,0 +6,0 @@ "allowSyntheticDefaultImports": true,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40060

increased by2.51%

Number of package files

46

increased by4.55%

Lines of code

647

increased by2.37%

No dependency changes