walk-back - npm Package Compare versions

Comparing version 5.1.0 to 5.1.1

index.js

@@ -0,7 +1,10 @@
+import path from 'path'
+import fs from 'fs'
+
 /**
- * Walk up the directory tree until the specified path is found.
+ * Walk up the directory tree until the specified path is found. For example, walk up through parent directories until a specified config file is found.
  *
  * @module walk-back
  * @example
- * const walkBack = require('walk-back')
+ * import walkBack from 'walk-back'
  */
@@ -33,4 +36,2 @@
 function walkBack (startAt, lookingFor) {
-  const path = require('path')
-  const fs = require('fs')
   startAt = path.resolve(startAt)
@@ -55,2 +56,2 @@ if (fs.existsSync(startAt) && fs.statSync(startAt).isDirectory()) {
 
-module.exports = walkBack
+export default walkBack

package.json

 {
   "name": "walk-back",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "description": "Walk up the directory tree until the specified path is found.",
   "repository": "https://github.com/75lb/walk-back",
   "license": "MIT",
-  "exports": "./index.js",
+  "type": "module",
+  "exports": {
+    "import": "./index.js",
+    "require": "./dist/index.cjs"
+  },
   "keywords": [
@@ -24,12 +28,13 @@ "walk",
   "scripts": {
-    "test": "test-runner test/test.js",
+    "test": "test-runner test/test.js test/test.cjs",
     "docs": "jsdoc2md -t README.hbs index.js > README.md"
   },
   "devDependencies": {
-    "jsdoc-to-markdown": "^7.0.1",
-    "test-runner": "^0.9.8"
+    "jsdoc-to-markdown": "^8.0.3",
+    "test-runner": "^0.12.0-1"
   },
   "files": [
-    "index.js"
+    "index.js",
+    "dist"
   ]
 }

README.md

@@ -5,15 +5,13 @@ [![view on npm](https://badgen.net/npm/v/walk-back)](https://www.npmjs.org/package/walk-back)
 [![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/walk-back)](https://github.com/75lb/walk-back/network/dependents?dependent_type=PACKAGE)
-[![Build Status](https://travis-ci.org/75lb/walk-back.svg?branch=master)](https://travis-ci.org/75lb/walk-back)
+[![Node.js CI](https://github.com/75lb/walk-back/actions/workflows/node.js.yml/badge.svg)](https://github.com/75lb/walk-back/actions/workflows/node.js.yml)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
 
-# walk-back
-
 <a name="module_walk-back"></a>
 
 ## walk-back
-Walk up the directory tree until the specified path is found.
+Walk up the directory tree until the specified path is found. For example, walk up through parent directories until a specified config file is found.
 
 **Example**  
 ```js
-const walkBack = require('walk-back')
+import walkBack from 'walk-back'
 ```
@@ -52,4 +50,4 @@ <a name="exp_module_walk-back--walkBack"></a>
 
-&copy; 2015-21 Lloyd Brookes \<[e-mail]\>.
+&copy; 2015-24 Lloyd Brookes \<[e-mail]\>.
 
 Tested by [test-runner](https://github.com/test-runner-js/test-runner). Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

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

8329

increased by29.88%

Number of package files

6

increased by20%

Lines of code

103

increased by101.96%

Is type module

Yes

Worsened metrics

Number of lines in readme file

52

decreased by-3.7%

Number of low supply chain risk alerts

3

increased by50%

No dependency changes