@walrus/shared-utils
    TypeScript icon, indicating that this package has built-in type declarations

    0.4.1 • Public • Published

    @walrus/shared-utils

    Alita NPM version NPM downloads

    项目集成了多种工具方法,可作为 cli 的依赖包

    📦 Install

    // npm
    npm install @walrus/shared-utils
    
    // yarn
    yarn add @walrus/shared-utils
    

    🔨 Usage

    import { lodash } form '@walrus/shared-utils';
    
    const result = true;
    
    if (lodash.isBoolean(result)) {
      console.log('result is boolean type');
    }
    

    🎉 目录

    ✨ API

    lodash

    import { lodash } form '@walrus/shared-utils';
    

    文档请查看lodash

    isLinux

    • 使用:
    import { isLinux } form '@walrus/shared-utils';
    
    • 类型:
    () => boolean;
    
    • 描述: 是否是 Linux 系统

    isMacintosh

    • 使用:
    import { isLinux } form '@walrus/shared-utils';
    
    • 类型:
    () => boolean;
    
    • 描述: 是否是 Mac 系统

    isWindows

    • 使用:
    import { isWindows } form '@walrus/shared-utils';
    
    • 类型:
    () => boolean;
    
    • 描述: 是否是 Windows 系统

    isUrl

    • 使用:
    import { isUrl } form '@walrus/shared-utils';
    
    • 类型:
    (path: string) => boolean;
    
    • 描述: path 是否是 Url

    clearConsole

    • 使用:
    import { clearConsole } form '@walrus/shared-utils';
    
    • 类型:
    () => void;
    
    • 描述: 清空控制台

    compatDirname

    • 使用:
    import { compatDirname } form '@walrus/shared-utils';
    
    • 类型:
    (path: string, cwd: string, fallback) => void;
    
    • 描述: 查找模块路径

    configLoader

    封装joycon支持读取.ts后缀配置文件,具体 API 请查看joycon

    • 使用:
    import { compatDirname } form '@walrus/shared-utils';
    
    const userConfig = configLoader.loadSync([
      'walrus.config.js',
      'walrus.config.ts'
    ], process.cwd());
    
    • 类型:

    • 描述: 读取配置文件

    checkNodeVersion

    • 使用:
    import { checkNodeVersion } form '@walrus/shared-utils';
    
    // 获取node兼容版本
    const requiredVersion = require('../package.json').engines.node;
    
    checkNodeVersion(checkNodeVersion, '@walrus/cli')
    
    • 类型:
    (wanted: string, id: string) => void
    
    • 描述: 检查 Node 版本

    chalk

    导出chalk, 具体文档请查看chalk

    • 使用:
    import { chalk } form '@walrus/shared-utils';
    

    signale

    可扩展的日志记录器

    导出signale, 具体文档请查看signale

    • 使用:
    import { signale } form '@walrus/shared-utils';
    

    semver

    导出semver, 具体文档请查看semver

    • 使用:
    import { semver } form '@walrus/shared-utils';
    

    Install

    npm i @walrus/shared-utils

    DownloadsWeekly Downloads

    29

    Version

    0.4.1

    License

    MIT

    Unpacked Size

    29.2 kB

    Total Files

    33

    Last publish

    Collaborators

    • wangxingkang
    • wangxingkang1314