@ohos-ports/pifs 0.0.0-stage → 2.0.0-beta.1

package/license.md

@@ -0,0 +1,22 @@
+# The MIT License (MIT)
+
+* Copyright (c) 2019–2020 Bubble Dev
+* Copyright (c) 2020–present NexTools
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/node/index.js

@@ -0,0 +1,146 @@
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.WriteStream = exports.ReadStream = exports.Stats = exports.Dirent = exports.writeFile = exports.write = exports.watchFile = exports.watch = exports.utimes = exports.unwatchFile = exports.unlink = exports.truncate = exports.symlink = exports.stat = exports.rmdir = exports.rename = exports.realpath = exports.readlink = exports.readFile = exports.readdir = exports.read = exports.open = exports.mkdtemp = exports.mkdir = exports.lstat = exports.link = exports.lchown = exports.lchmod = exports.futimes = exports.ftruncate = exports.fsync = exports.fstat = exports.fdatasync = exports.fchown = exports.fchmod = exports.createWriteStream = exports.createReadStream = exports.copyFile = exports.constants = exports.close = exports.chown = exports.chmod = exports.appendFile = exports.access = void 0;
+
+var _util = require("util");
+
+var _gracefulFs = _interopRequireDefault(require("graceful-fs"));
+
+const access = (0, _util.promisify)(_gracefulFs.default.access);
+exports.access = access;
+const appendFile = (0, _util.promisify)(_gracefulFs.default.appendFile);
+exports.appendFile = appendFile;
+const chmod = (0, _util.promisify)(_gracefulFs.default.chmod);
+exports.chmod = chmod;
+const chown = (0, _util.promisify)(_gracefulFs.default.chown);
+exports.chown = chown;
+const close = (0, _util.promisify)(_gracefulFs.default.close);
+exports.close = close;
+const constants = _gracefulFs.default.constants;
+exports.constants = constants;
+const copyFile = (0, _util.promisify)(_gracefulFs.default.copyFile);
+exports.copyFile = copyFile;
+const createReadStream = _gracefulFs.default.createReadStream;
+exports.createReadStream = createReadStream;
+const createWriteStream = _gracefulFs.default.createWriteStream;
+exports.createWriteStream = createWriteStream;
+const fchmod = (0, _util.promisify)(_gracefulFs.default.fchmod);
+exports.fchmod = fchmod;
+const fchown = (0, _util.promisify)(_gracefulFs.default.fchown);
+exports.fchown = fchown;
+const fdatasync = (0, _util.promisify)(_gracefulFs.default.fdatasync);
+exports.fdatasync = fdatasync;
+const fstat = (0, _util.promisify)(_gracefulFs.default.fstat);
+exports.fstat = fstat;
+const fsync = (0, _util.promisify)(_gracefulFs.default.fsync);
+exports.fsync = fsync;
+const ftruncate = (0, _util.promisify)(_gracefulFs.default.ftruncate);
+exports.ftruncate = ftruncate;
+const futimes = (0, _util.promisify)(_gracefulFs.default.futimes);
+exports.futimes = futimes;
+const lchmod = (0, _util.promisify)(_gracefulFs.default.lchmod);
+exports.lchmod = lchmod;
+const lchown = (0, _util.promisify)(_gracefulFs.default.lchown);
+exports.lchown = lchown;
+const link = (0, _util.promisify)(_gracefulFs.default.link);
+exports.link = link;
+const lstat = (0, _util.promisify)(_gracefulFs.default.lstat);
+exports.lstat = lstat;
+const mkdir = (0, _util.promisify)(_gracefulFs.default.mkdir);
+exports.mkdir = mkdir;
+const mkdtemp = (0, _util.promisify)(_gracefulFs.default.mkdtemp);
+exports.mkdtemp = mkdtemp;
+const open = (0, _util.promisify)(_gracefulFs.default.open);
+exports.open = open;
+const read = (0, _util.promisify)(_gracefulFs.default.read);
+exports.read = read;
+const readdir = (0, _util.promisify)(_gracefulFs.default.readdir);
+exports.readdir = readdir;
+const readFile = (0, _util.promisify)(_gracefulFs.default.readFile);
+exports.readFile = readFile;
+const readlink = (0, _util.promisify)(_gracefulFs.default.readlink);
+exports.readlink = readlink;
+const realpath = (0, _util.promisify)(_gracefulFs.default.realpath);
+exports.realpath = realpath;
+const rename = (0, _util.promisify)(_gracefulFs.default.rename);
+exports.rename = rename;
+const rmdir = (0, _util.promisify)(_gracefulFs.default.rmdir);
+exports.rmdir = rmdir;
+const stat = (0, _util.promisify)(_gracefulFs.default.stat);
+exports.stat = stat;
+const symlink = (0, _util.promisify)(_gracefulFs.default.symlink);
+exports.symlink = symlink;
+const truncate = (0, _util.promisify)(_gracefulFs.default.truncate);
+exports.truncate = truncate;
+const unlink = (0, _util.promisify)(_gracefulFs.default.unlink);
+exports.unlink = unlink;
+const unwatchFile = _gracefulFs.default.unwatchFile;
+exports.unwatchFile = unwatchFile;
+const utimes = (0, _util.promisify)(_gracefulFs.default.utimes);
+exports.utimes = utimes;
+const watch = _gracefulFs.default.watch;
+exports.watch = watch;
+const watchFile = _gracefulFs.default.watchFile;
+exports.watchFile = watchFile;
+const write = (0, _util.promisify)(_gracefulFs.default.write);
+exports.write = write;
+const writeFile = (0, _util.promisify)(_gracefulFs.default.writeFile);
+exports.writeFile = writeFile;
+const Dirent = _gracefulFs.default.Dirent;
+exports.Dirent = Dirent;
+const Stats = _gracefulFs.default.Stats;
+exports.Stats = Stats;
+const ReadStream = _gracefulFs.default.ReadStream;
+exports.ReadStream = ReadStream;
+const WriteStream = _gracefulFs.default.WriteStream;
+exports.WriteStream = WriteStream;
+var _default = {
+  access,
+  appendFile,
+  chmod,
+  chown,
+  close,
+  constants,
+  copyFile,
+  createReadStream,
+  createWriteStream,
+  fchmod,
+  fchown,
+  fdatasync,
+  fstat,
+  fsync,
+  ftruncate,
+  futimes,
+  lchmod,
+  lchown,
+  link,
+  lstat,
+  mkdir,
+  mkdtemp,
+  open,
+  read,
+  readdir,
+  readFile,
+  readlink,
+  realpath,
+  rename,
+  rmdir,
+  stat,
+  symlink,
+  truncate,
+  unlink,
+  unwatchFile,
+  utimes,
+  watch,
+  watchFile,
+  write,
+  writeFile,
+  Dirent,
+  Stats,
+  ReadStream,
+  WriteStream
+};
+exports.default = _default;

package/package.json

@@ -1,6 +1,30 @@
 {
   "name": "@ohos-ports/pifs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "2.0.0-beta.1",
+  "description": "Promisified graceful-fs",
+  "keywords": [
+    "fs",
+    "graceful-fs",
+    "promise",
+    "promisify"
+  ],
+  "types": "types/index.d.ts",
+  "main": "node/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/pifs/2.0.0"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=12.13.0"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.0.0",
+    "@types/graceful-fs": "^4.1.3",
+    "graceful-fs": "^4.2.0"
+  },
+  "bugs": {
+    "url": "https://github.com/ohos-ports/ohos-ports/issues"
+  }
+}

package/readme.md

@@ -0,0 +1,28 @@
+# pifs ![npm](https://flat.badgen.net/npm/v/pifs)
+
+Promisified [graceful-fs](https://github.com/isaacs/node-graceful-fs).
+
+* aligned with Node.js v10
+* native `util.promisify()`
+* no sync methods
+* no deprecated methods like `exists`
+* no undocumented exports like `FileReadStream` or `F_OK`
+* no `promises` :)
+* non-callback methods like `createReadStream` or `watch` are re-exported as is
+* `constants` is re-exported as is
+
+## Install
+
+```sh
+$ yarn add pifs
+```
+
+## Usage
+
+```js
+import { readFile } from 'pifs'
+
+readFile('/file/path', 'utf8')
+  .then(console.log)
+  .catch(console.error)
+```

package/types/index.d.ts

@@ -0,0 +1,93 @@
+/// <reference types="node" />
+import fs from 'graceful-fs';
+export declare const access: typeof fs.access.__promisify__;
+export declare const appendFile: typeof fs.appendFile.__promisify__;
+export declare const chmod: typeof fs.chmod.__promisify__;
+export declare const chown: typeof fs.chown.__promisify__;
+export declare const close: typeof fs.close.__promisify__;
+export declare const constants: typeof fs.constants;
+export declare const copyFile: typeof fs.copyFile.__promisify__;
+export declare const createReadStream: typeof fs.createReadStream;
+export declare const createWriteStream: typeof fs.createWriteStream;
+export declare const fchmod: typeof fs.fchmod.__promisify__;
+export declare const fchown: typeof fs.fchown.__promisify__;
+export declare const fdatasync: typeof fs.fdatasync.__promisify__;
+export declare const fstat: typeof fs.fstat.__promisify__;
+export declare const fsync: typeof fs.fsync.__promisify__;
+export declare const ftruncate: typeof fs.ftruncate.__promisify__;
+export declare const futimes: typeof fs.futimes.__promisify__;
+export declare const lchmod: typeof fs.lchmod.__promisify__;
+export declare const lchown: typeof fs.lchown.__promisify__;
+export declare const link: typeof fs.link.__promisify__;
+export declare const lstat: typeof fs.lstat.__promisify__;
+export declare const mkdir: typeof fs.mkdir.__promisify__;
+export declare const mkdtemp: typeof fs.mkdtemp.__promisify__;
+export declare const open: typeof fs.open.__promisify__;
+export declare const read: typeof fs.read.__promisify__;
+export declare const readdir: typeof fs.readdir.__promisify__;
+export declare const readFile: typeof fs.readFile.__promisify__;
+export declare const readlink: typeof fs.readlink.__promisify__;
+export declare const realpath: typeof fs.realpath.__promisify__;
+export declare const rename: typeof fs.rename.__promisify__;
+export declare const rmdir: typeof fs.rmdir.__promisify__;
+export declare const stat: typeof fs.stat.__promisify__;
+export declare const symlink: typeof fs.symlink.__promisify__;
+export declare const truncate: typeof fs.truncate.__promisify__;
+export declare const unlink: typeof fs.unlink.__promisify__;
+export declare const unwatchFile: typeof fs.unwatchFile;
+export declare const utimes: typeof fs.utimes.__promisify__;
+export declare const watch: typeof fs.watch;
+export declare const watchFile: typeof fs.watchFile;
+export declare const write: typeof fs.write.__promisify__;
+export declare const writeFile: typeof fs.writeFile.__promisify__;
+export declare const Dirent: typeof fs.Dirent;
+export declare const Stats: typeof fs.Stats;
+export declare const ReadStream: typeof fs.ReadStream;
+export declare const WriteStream: typeof fs.WriteStream;
+declare const _default: {
+    access: typeof fs.access.__promisify__;
+    appendFile: typeof fs.appendFile.__promisify__;
+    chmod: typeof fs.chmod.__promisify__;
+    chown: typeof fs.chown.__promisify__;
+    close: typeof fs.close.__promisify__;
+    constants: typeof fs.constants;
+    copyFile: typeof fs.copyFile.__promisify__;
+    createReadStream: typeof fs.createReadStream;
+    createWriteStream: typeof fs.createWriteStream;
+    fchmod: typeof fs.fchmod.__promisify__;
+    fchown: typeof fs.fchown.__promisify__;
+    fdatasync: typeof fs.fdatasync.__promisify__;
+    fstat: typeof fs.fstat.__promisify__;
+    fsync: typeof fs.fsync.__promisify__;
+    ftruncate: typeof fs.ftruncate.__promisify__;
+    futimes: typeof fs.futimes.__promisify__;
+    lchmod: typeof fs.lchmod.__promisify__;
+    lchown: typeof fs.lchown.__promisify__;
+    link: typeof fs.link.__promisify__;
+    lstat: typeof fs.lstat.__promisify__;
+    mkdir: typeof fs.mkdir.__promisify__;
+    mkdtemp: typeof fs.mkdtemp.__promisify__;
+    open: typeof fs.open.__promisify__;
+    read: typeof fs.read.__promisify__;
+    readdir: typeof fs.readdir.__promisify__;
+    readFile: typeof fs.readFile.__promisify__;
+    readlink: typeof fs.readlink.__promisify__;
+    realpath: typeof fs.realpath.__promisify__;
+    rename: typeof fs.rename.__promisify__;
+    rmdir: typeof fs.rmdir.__promisify__;
+    stat: typeof fs.stat.__promisify__;
+    symlink: typeof fs.symlink.__promisify__;
+    truncate: typeof fs.truncate.__promisify__;
+    unlink: typeof fs.unlink.__promisify__;
+    unwatchFile: typeof fs.unwatchFile;
+    utimes: typeof fs.utimes.__promisify__;
+    watch: typeof fs.watch;
+    watchFile: typeof fs.watchFile;
+    write: typeof fs.write.__promisify__;
+    writeFile: typeof fs.writeFile.__promisify__;
+    Dirent: typeof fs.Dirent;
+    Stats: typeof fs.Stats;
+    ReadStream: typeof fs.ReadStream;
+    WriteStream: typeof fs.WriteStream;
+};
+export default _default;

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.