readify 10.0.0 → 11.0.0

package/ChangeLog

@@ -1,3 +1,31 @@
+2026.03.17, v11.0.0
+
+feature:
+- 7a5a512 readify: drop support of node < 22
+- affeb7e readify: migrate to ESM
+- e7ae40e readdir: get rid of mock-require
+- b460323 readify: export: default -> named
+- f0ea5c7 readify: get rid of mock-require
+- aebe67e readify: try-to-catch v4.0.5
+- d177938 readify: try-catch v4.0.9
+- beb6869 readify: supertape v12.10.5
+- f7e52c0 readify: putout v42.2.3
+- 9ebc9e9 readify: madrun v13.0.1
+- 7a10046 readify: eslint-plugin-putout v31.1.1
+- 519aaba readify: eslint v10.0.3
+- 611e819 readify: @cloudcmd/formatify v3.0.0
+- 8cf2542 readify: superc8 v12.3.1
+- 22a59d7 readify: putout v37.1.0
+- e59d19f readify: eslint-plugin-putout v23.3.0
+
+2024.08.16, v10.0.1
+
+feature:
+- cba73a1 readify: @cloudcmd/formatify v2.0.0
+- 76b6045 readify: putout v36.0.3
+- a4597a1 readify: eslint v9.9.0
+- 0511e66 readify: c8 v10.1.2
+
 2024.03.29, v10.0.0
 
 feature:

package/README.md

@@ -32,8 +32,9 @@ npm i readify
 ## Examples
 
 ```js
-const readify = require('readify');
-const tryToCatch = require('try-to-catch');
+import {readify} from 'readify';
+
+const {tryToCatch} = require('try-to-catch');
 
 const [error, data] = await tryToCatch(readify, '/');
 console.log(data);
@@ -53,6 +54,7 @@ console.log(data);
 readify('/', {
     type: 'raw',
 }).then(console.log);
+
 // output
 ({
     path: '/',
@@ -71,6 +73,7 @@ readify('/', {
     sort: 'size',
     order: 'desc',
 }).then(console.log);
+
 // output
 ({
     path: '/',

package/lib/readdir.js

@@ -1,16 +1,13 @@
-'use strict';
-
-const {join, extname} = require('path');
-const {readdir} = require('fs/promises');
-
-const tryToCatch = require('try-to-catch');
-const superstat = require('superstat');
-const currify = require('currify');
+import {join, extname} from 'node:path';
+import {readdir as _readdir} from 'node:fs/promises';
+import currify from 'currify';
+import {tryToCatch} from 'try-to-catch';
+import _superstat from 'superstat';
 
 const noop = () => {};
 const {assign} = Object;
 
-const stat = currify(async (dir, name) => {
+const stat = currify(async (superstat, dir, name) => {
     const full = join(dir, name);
     const [, info = empty()] = await tryToCatch(superstat, full);
     
@@ -19,38 +16,48 @@ const stat = currify(async (dir, name) => {
     });
 });
 
-module.exports = async (dir) => {
+export const readdir = async (dir, overrides = {}) => {
+    const {
+        readdir = _readdir,
+        superstat = _superstat,
+    } = overrides;
+    
     const names = await readdir(dir);
     
-    const statsPromises = names.map(stat(dir));
+    const statsPromises = names.map(stat(superstat, dir));
     const stats = await Promise.all(statsPromises);
     
     return stats.map(parseStat);
 };
 
-function empty(name) {
-    return {
-        name,
-        uid: 0,
-        mode: 0,
-        size: 0,
-        mtime: 0,
-        isDirectory: noop,
-        isSymbolicLink: noop,
-    };
-}
+const empty = (name) => ({
+    name,
+    uid: 0,
+    mode: 0,
+    size: 0,
+    mtime: 0,
+    isDirectory: noop,
+    isSymbolicLink: noop,
+});
 
 function parseStat(stat) {
-    const {name} = stat;
+    const {
+        name,
+        size,
+        mtime,
+        mode,
+        uid,
+    } = stat;
+    
     const isDir = stat.isDirectory();
     const isLink = stat.isSymbolicLink();
     
     return {
         name,
-        size: stat.size,
-        date: stat.mtime,
-        owner: stat.uid,
-        mode: stat.mode,
+        size,
+        date: mtime,
+        owner: uid,
+        mode,
         type: getType({
             name,
             isDir,

package/lib/readify.js

@@ -1,29 +1,24 @@
-'use strict';
+import format from 'format-io';
+import currify from 'currify';
+import {tryToCatch} from 'try-to-catch';
+import sortify from '@cloudcmd/sortify';
+import {formatify} from '@cloudcmd/formatify';
+import _nicki from 'nicki';
+import {readdir as _readdir} from './readdir.js';
 
-const process = require('node:process');
 const isUndefined = (a) => typeof a === 'undefined';
-const format = require('format-io');
-const currify = require('currify');
-const tryToCatch = require('try-to-catch');
 
-const sortify = require('@cloudcmd/sortify');
-const formatify = require('@cloudcmd/formatify');
-
-const WIN = process.platform === 'win32';
-
-const readdir = require('./readdir');
-const nicki = !WIN && require('nicki');
 const replaceProperty = currify(_replaceProperty);
 const ifRaw = currify(_ifRaw);
 const isString = (a) => typeof a === 'string';
 
-module.exports = readify;
-
-async function readify(path, options = {}) {
+export const readify = async (path, options = {}) => {
     const {
         type,
         order,
         sort = 'name',
+        nicki = _nicki,
+        readdir = _readdir,
     } = options;
     
     check({
@@ -38,8 +33,10 @@ async function readify(path, options = {}) {
     const sorted = sortify({sort, order}, names);
     const formated = ifRaw(type, formatify, sorted);
     
-    return await fillJSON(path, type, formated);
-}
+    return await fillJSON(path, type, formated, {
+        nicki,
+    });
+};
 
 function check({path, type, sort, order}) {
     if (!isString(path))
@@ -62,7 +59,7 @@ function _ifRaw(type, fn, a) {
     return fn(a);
 }
 
-async function fillJSON(dir, type, files) {
+async function fillJSON(dir, type, files, {nicki}) {
     const path = format.addSlashToEnd(dir);
     
     if (type === 'raw')
@@ -71,7 +68,9 @@ async function fillJSON(dir, type, files) {
             files,
         };
     
-    const newFiles = await changeUIDToName(files);
+    const newFiles = await changeUIDToName(files, {
+        nicki,
+    });
     
     return {
         path,
@@ -79,13 +78,10 @@ async function fillJSON(dir, type, files) {
     };
 }
 
-async function changeUIDToName(files) {
-    if (!nicki)
-        return files;
-    
+async function changeUIDToName(files, {nicki}) {
     const [e, names] = await tryToCatch(nicki);
     
-    if (e)
+    if (e || !names)
         return files;
     
     const replaceOwner = replaceProperty(names, 'owner');

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "readify",
-  "version": "10.0.0",
-  "type": "commonjs",
+  "version": "11.0.0",
+  "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Read directory content with file attributes: size, date, owner, mode",
   "homepage": "http://github.com/coderaiser/readify",
   "repository": {
     "type": "git",
-    "url": "git://github.com/coderaiser/readify.git"
+    "url": "git+https://github.com/coderaiser/readify.git"
   },
   "scripts": {
     "lint": "madrun lint",
@@ -20,14 +20,14 @@
     "watcher": "madrun watcher"
   },
   "dependencies": {
-    "@cloudcmd/formatify": "^1.0.0",
+    "@cloudcmd/formatify": "^3.0.0",
     "@cloudcmd/sortify": "^2.0.0",
     "currify": "^4.0.0",
     "format-io": "^2.0.0",
     "nicki": "^6.0.0",
     "shortdate": "^2.0.0",
     "superstat": "^2.0.0",
-    "try-to-catch": "^3.0.0"
+    "try-to-catch": "^4.0.5"
   },
   "keywords": [
     "read",
@@ -44,19 +44,17 @@
   "license": "MIT",
   "main": "lib/readify.js",
   "engines": {
-    "node": ">=18"
+    "node": ">=22"
   },
   "devDependencies": {
-    "c8": "^9.1.0",
-    "eslint": "^8.57.0",
-    "eslint-plugin-n": "^16.6.2",
-    "eslint-plugin-putout": "^22.5.0",
-    "madrun": "^10.0.1",
-    "mock-require": "^3.0.2",
+    "eslint": "^10.0.3",
+    "eslint-plugin-putout": "^31.1.1",
+    "madrun": "^13.0.1",
     "nodemon": "^3.1.0",
-    "putout": "^35.7.6",
-    "supertape": "^10.5.0",
-    "try-catch": "^3.0.0"
+    "putout": "^42.2.3",
+    "superc8": "^12.3.1",
+    "supertape": "^12.10.5",
+    "try-catch": "^4.0.9"
   },
   "publishConfig": {
     "access": "public"