@form8ion/javascript-core

应报道# javascript- core

与 JavaScript 相關的窗体8ion 工具的核心逻辑, 如 javascript-脚手 财务报告和审定财务报表 升起标记

目录

• 使用量
  • 安装
  • 示例
    • 导入
    • 执行
  • API 密码
    • scaffoldChoice
      • choices 对象 (单位:千美元)所需经费(中文(简体) )
      • choice 字符串 (单位:千美元)所需经费(中文(简体) )
      • options 对象 (单位:千美元)选项(中文(简体) )
    • installDependencies
      • dependencies 字符串列表 (单位:千美元)所需经费(中文(简体) )
      • dependenciesType 字符串 (单位:千美元)所需经费(中文(简体) )
      • projectRoot 字符串 (单位:千美元)选项(中文(简体) )
      • packageManger 字符串 (单位:千美元)选项(中文(简体) )
        • 依赖类型
    • projectTypes
    • packageManagers
    • dialects
    • projectTypeShouldBePublished
      • projectType 字符串 (单位:千美元)所需经费(中文(简体) )
    • coverageShouldBeReported
      • visibility 字符串 (单位:千美元)所需经费(中文(简体) )
      • tests 对象 (单位:千美元)所需经费(中文(简体) )
    • writePackageJson
      • projectRoot 字符串 (单位:千美元)所需经费(中文(简体) )
      • config 对象 (单位:千美元)所需经费(中文(简体) )
    • mergeIntoExistingPackageJson
      • projectRoot 字符串 (单位:千美元)所需经费(中文(简体) )
      • config 对象 (单位:千美元)所需经费(中文(简体) )
    • 节点版本类别
      • determineLtsNodeMajorVersions
        • withinRange 字符串 (单位:千美元)选项(中文(简体) )
      • determineSupportedNodeMajorVersions
        • withinRange 字符串 (单位:千美元)选项(中文(简体) )
• 捐款
  • 依赖关系
  • 核查

使用量

安装

$ npm install @form8ion/javascript-core --save-prod

示例

导入

const {scaffoldChoice} = require('@form8ion/javascript-core');

执行

(async () => {
  await scaffoldChoice(
    {foo: {scaffold: options => options}},
    'foo',
    {bar: 'baz'}
  );
})();

API 密码

scaffoldChoice

执行 scaffolder 函数从提供的映射 选项名称.

需要三个未知参数:

choices 对象 (单位:千美元)所需经费(中文(简体) )

• 键 : 字符串 选择名称
• 值 : 对象
  • scaffolder数字 : 函数 (单位:千美元)所需经费脚手架 选择选项

choice 字符串 (单位:千美元)所需经费(中文(简体) )

选取之名. 应匹配来自 choices 对象。 。 。 .

options 对象 (单位:千美元)选项(中文(简体) )

选项

installDependencies

安装所提供软件包依赖性的函数 .

需要四个未命名的参数:

dependencies 字符串列表 (单位:千美元)所需经费(中文(简体) )

要安装的包名列表 .

dependenciesType 字符串 (单位:千美元)所需经费(中文(简体) )

定义所提供软件包名称的列表是否应当作为 prod 或 德从相依. 如果提供了“ dev ” ,则列表将安装在 --save-exact 旗帜.

projectRoot 字符串 (单位:千美元)选项(中文(简体) )

工程根的文件系统路径

packageManger 字符串 (单位:千美元)选项(中文(简体) )

指定用于依赖的软件包管理器的名称 安装。 默认为 npm

依赖类型

用于定义有效选项的常数 dependenciesType

• PROD_DEPENDENCY_TYPE
• DEV_DEPENDENCY_TYPE

projectTypes

定义 JavaScript 项目类型的常数

• APPLICATION
• PACKAGE
• CLI

packageManagers

定义可用软件包管理器的常数

• NPM
• YARN

dialects

定义可用的 JavaScript 源方言的常数

• COMMON_JS
• BABEL
• ESM
• TYPESCRIPT

projectTypeShouldBePublished

优先指定函数以确定是否 项目类型 是一个 应公布

还有一个论点:

projectType 字符串 (单位:千美元)所需经费(中文(简体) )

应该是一个 项目类型 选项

coverageShouldBeReported

确定是否应报告覆盖范围的预设职能

有两个论点:

visibility 字符串 (单位:千美元)所需经费(中文(简体) )

项目的能见度(Public 或者说 Private(中文(简体) )

tests 对象 (单位:千美元)所需经费(中文(简体) )

• unit 布尔 (单位:千美元)选项(中文(简体) ) 项目是否进行单元测试

writePackageJson

将提供的配置写入 package.json 项目

接受一个选项对象作为唯一参数,其属性如下:

projectRoot 字符串 (单位:千美元)所需经费(中文(简体) )

工程根的文件系统路径

config 对象 (单位:千美元)所需经费(中文(简体) )

要写入的配置 package.json 作为表格的全部内容 文件

mergeIntoExistingPackageJson

将所提供的配置合并到现有的 package.json 项目

接受一个选项对象作为唯一参数,其属性如下:

projectRoot 字符串 (单位:千美元)所需经费(中文(简体) )

工程根的文件系统路径

config 对象 (单位:千美元)所需经费(中文(简体) )

将配置与当前内容合并 package.json

节点版本类别

帮助在定义的类别中确定支持的节点.js版本 一揽子支助准则。 。 。 . 参见 发布时间表 页:1 当前状态.

determineLtsNodeMajorVersions

返回当前 LTS 主要版本列表 活动 或者说 维修 状态,可选择由提供的 semver 范围过滤.

接受一个选项对象作为唯一参数,其属性如下:

withinRange 字符串 (单位:千美元)选项(中文(简体) )

与 节点集成器, (中文(简体) ), 来过滤当前主要 LTS 版本的列表.

determineSupportedNodeMajorVersions

返回目前未处于报废状态的主要版本清单, 可选择通过提供的分解范围过滤.

接受一个选项对象作为唯一参数,其属性如下:

withinRange 字符串 (单位:千美元)选项(中文(简体) )

与 节点集成器, (中文(简体) ), 来过滤当前主要 LTS 版本的列表.

捐款

依赖关系

$ nvm install
$ npm install

核查

$ npm test