get-installed-apps 项目使用教程

get-installed-apps 项目使用教程

1. 项目的目录结构及介绍

get-installed-apps/
├── github/
│   └── workflows/
├── src/
├── test/
├── .gitignore
├── LICENSE
├── README-zh_CN.md
├── README.md
├── example.js
├── package-lock.json
├── package.json
└── tsconfig.json

• github/workflows/: 包含GitHub Actions的工作流配置文件。
• src/: 项目的源代码目录。
• test/: 项目的测试代码目录。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目的许可证文件。
• README-zh_CN.md: 项目的中文介绍文档。
• README.md: 项目的英文介绍文档。
• example.js: 项目的示例代码文件。
• package-lock.json: 锁定依赖版本的文件。
• package.json: 项目的配置文件，包含依赖、脚本等信息。
• tsconfig.json: TypeScript配置文件。

2. 项目的启动文件介绍

项目的启动文件是 example.js，它展示了如何使用 get-installed-apps 模块来获取已安装的应用程序信息。

// example.js
import { getInstalledApps } from 'get-installed-apps';

getInstalledApps().then(apps => {
  console.log(apps);
});

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的基本信息、依赖和脚本等配置。

{
  "name": "get-installed-apps",
  "version": "1.0.0",
  "description": "Get installed app using Node.js supporting Windows and macOS",
  "main": "index.js",
  "scripts": {
    "start": "node example.js"
  },
  "dependencies": {
    "get-installed-apps": "^1.0.0"
  },
  "license": "MIT"
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目的主入口文件。
• scripts: 包含可执行的脚本命令，如 start 命令用于启动项目。
• dependencies: 项目的依赖包。
• license: 项目的许可证。

tsconfig.json

tsconfig.json 文件是TypeScript的配置文件，用于配置TypeScript编译选项。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true
  },
  "include": [
    "src/**/*"
  ]
}

• compilerOptions: 编译选项，如目标JavaScript版本、模块系统、输出目录等。
• include: 包含的文件或目录，用于指定哪些文件需要被编译。