@restroom-mw/git - npm Package Compare versions

Comparing version 0.13.1-5ccb015.88 to 0.13.1-66c2453.105

dist/actions.d.ts

 export declare enum Action {
     /**
-     * Verify that the given directory is a git repository
-     * (i.e. it exists the .git directory)
+     * `Given I verify the path 'myFolder' is a git repository`<br><br>
+     * Verify that the directory defined by the path *myFolder*, under the *FILES_DIR*
+     * directory, is a git repository (i.e. it exists the .git directory)
+     * @param {string} myFolder - Name of the variable containing the path
+     *        or the path itself
      */
     VERIFY = "verify the path {} is a git repository",
     /**
-     * Clone the repository in the specified directory under
-     * the `FILES_DIR` directory
+     * `Given I clone the repository 'myRepo' in 'myDirectory'`<br><br>
+     * Clone the repository *myRepo* in the specified directory *myDirectory* under
+     * the *FILES_DIR* directory
+     * @param {string} myRepo - Name of the variable containing the repository url
+     *        or the repository url itself
+     * @param {string} myDirectory - Name of the variable containing the path
+     *        or the path itself where the repo will be cloned
      */
     CLONE = "clone the repository {} in {}",
     /**
-     * Add files to a local repository and
-     * create a commit in the repository
+     * `Then make a new commit to the git repository in 'myDirectory'`<br><br>
+     * Add files to a local repository *myDirectory* and create a commit in the repository,
+     * the commit that will be created is passed in the data or in the output as:
+     * ```json
+     * {"commit": {
+     *   "message": "My interesting random file",
+     *   "author": "restroom",
+     *   "email": "[e-mail]",
+     *   "files": ["interestingFile.txt"]
+     * }}
+     * ```
+     * @param {string} myDirectory - Name of the variable containing the path to the
+     *        local repository or the path itself
      */
@@ -16,0 +35,0 @@ COMMIT = "make a new commit to the git repository in {}"

dist/actions.js

@@ -7,16 +7,35 @@ "use strict";
     /**
-     * Verify that the given directory is a git repository
-     * (i.e. it exists the .git directory)
+     * `Given I verify the path 'myFolder' is a git repository`<br><br>
+     * Verify that the directory defined by the path *myFolder*, under the *FILES_DIR*
+     * directory, is a git repository (i.e. it exists the .git directory)
+     * @param {string} myFolder - Name of the variable containing the path
+     *        or the path itself
      */
     Action["VERIFY"] = "verify the path {} is a git repository";
     /**
-     * Clone the repository in the specified directory under
-     * the `FILES_DIR` directory
+     * `Given I clone the repository 'myRepo' in 'myDirectory'`<br><br>
+     * Clone the repository *myRepo* in the specified directory *myDirectory* under
+     * the *FILES_DIR* directory
+     * @param {string} myRepo - Name of the variable containing the repository url
+     *        or the repository url itself
+     * @param {string} myDirectory - Name of the variable containing the path
+     *        or the path itself where the repo will be cloned
      */
     Action["CLONE"] = "clone the repository {} in {}";
     /**
-     * Add files to a local repository and
-     * create a commit in the repository
+     * `Then make a new commit to the git repository in 'myDirectory'`<br><br>
+     * Add files to a local repository *myDirectory* and create a commit in the repository,
+     * the commit that will be created is passed in the data or in the output as:
+     * ```json
+     * {"commit": {
+     *   "message": "My interesting random file",
+     *   "author": "restroom",
+     *   "email": "[e-mail]",
+     *   "files": ["interestingFile.txt"]
+     * }}
+     * ```
+     * @param {string} myDirectory - Name of the variable containing the path to the
+     *        local repository or the path itself
      */
     Action["COMMIT"] = "make a new commit to the git repository in {}";
 })(Action = exports.Action || (exports.Action = {}));

package.json

 {
   "name": "@restroom-mw/git",
-  "version": "0.13.1-5ccb015.88+5ccb015",
+  "version": "0.13.1-66c2453.105+66c2453",
   "description": "Git middleware for restroom",
@@ -39,3 +39,3 @@ "author": "Alberto Lerda <[e-mail]>",
   },
-  "gitHead": "5ccb015a1b0aab9eff25b7360e0a49dafa94b174",
+  "gitHead": "66c245381f00cbb6b1e1482fd19d1ea9455693f3",
   "devDependencies": {
@@ -42,0 +42,0 @@ "turbo": "^1.2.9"

src/actions.ts

 export enum Action {
   /**
-   * Verify that the given directory is a git repository
-   * (i.e. it exists the .git directory)
+   * `Given I verify the path 'myFolder' is a git repository`<br><br>
+   * Verify that the directory defined by the path *myFolder*, under the *FILES_DIR*
+   * directory, is a git repository (i.e. it exists the .git directory)
+   * @param {string} myFolder - Name of the variable containing the path
+   *        or the path itself
    */
   VERIFY = "verify the path {} is a git repository",
   /**
-   * Clone the repository in the specified directory under
-   * the `FILES_DIR` directory
+   * `Given I clone the repository 'myRepo' in 'myDirectory'`<br><br>
+   * Clone the repository *myRepo* in the specified directory *myDirectory* under
+   * the *FILES_DIR* directory
+   * @param {string} myRepo - Name of the variable containing the repository url
+   *        or the repository url itself
+   * @param {string} myDirectory - Name of the variable containing the path
+   *        or the path itself where the repo will be cloned
    */
   CLONE = "clone the repository {} in {}",
   /**
-   * Add files to a local repository and
-   * create a commit in the repository
+   * `Then make a new commit to the git repository in 'myDirectory'`<br><br>
+   * Add files to a local repository *myDirectory* and create a commit in the repository,
+   * the commit that will be created is passed in the data or in the output as:
+   * ```json
+   * {"commit": {
+   *   "message": "My interesting random file",
+   *   "author": "restroom",
+   *   "email": "[e-mail]",
+   *   "files": ["interestingFile.txt"]
+   * }}
+   * ```
+   * @param {string} myDirectory - Name of the variable containing the path to the
+   *        local repository or the path itself
    */
   COMMIT = "make a new commit to the git repository in {}",
 }

New alerts

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Fixed alerts

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

48915

increased by7.35%

Lines of code

275

increased by26.15%

No dependency changes