팁 공유: package.json 파일을 우아하게 얻기

일상적인 개발에서 우리는 package.json이 많은 메타 정보를 포함하는 프로젝트 또는 모듈 패키지에 대한 설명이라는 것을 알고 있습니다. 그렇다면 내부 정보를 얻으려면 package.json을 어떻게 읽어야 할까요? 오늘의 주인공은 read-pkg입니다. 핵심 소스 코드는 약 30줄에 불과하며, 이는 향후 개발을 위한 기반을 마련하는 것으로도 볼 수 있습니다. 툴킷! [관련 튜토리얼 추천: nodejs 비디오 튜토리얼]

Harvest list

• 디버그 소스 코드
• 우아하게 package.json 획득
• 정식 패키지 메타데이터
• import.meta.url 애플리케이션

유치원 준비

소스 코드 다운로드

git clone https://github.com/sindresorhus/read-pkg.git
cd read-pkg&&yarn

일반적으로 소스 코드를 학습할 때 먼저 README.md 및 package.json을 읽으십시오. Readme에서는 사용법을 가르치고 package.json에 명령이 표시됩니다. . 일반적으로 시작에서 package.json 스크립트를 디버그하고 스크린샷을 찍습니다.

이 명령을 처음 보면 devDependency를 살펴보면 무엇을 표현하려는지 모를 수도 있습니다. , 세 개의 명령이 세 개의 패키지에 해당한다는 것을 알게 될 것입니다. 패키지를 모르는 경우 무엇을 위한 것입니까? 직접 Baidu로 이동, 일반적인 패키지 사용법은 npm

• ava
  

node.js 테스트 패키지

• 에서 확인할 수 있습니다. tsd
  

적절한 기본값을 가진 TS 유형

• 
  
Xo

(ESLINT 패키징)을 감지하고, 패키지 스크립트에서 버튼을 클릭합니다. .json을 사용하여 디버깅을 활성화합니다. 해당 버튼이 없으면 vscode를 업데이트해야 할 수도 있습니다.

소스 코드 구조 분석调试脚本

종속성 소개

// node进程
import process from 'node:process';
// fs文件模块
import fs, {promises as fsPromises} from 'node:fs';
// path 路径模块
import path from 'node:path';
// url模块
import {fileURLToPath} from 'node:url';
// 解析json，并且会伴随有用的报错，https://github.com/sindresorhus/parse-json#readme
import parseJson from 'parse-json';
// 规范化包元数据 https://github.com/npm/normalize-package-data#readme
import normalizePackageData from 'normalize-package-data';

URL을 파일 경로로 변환

// fileURLToPath将url转化为文件路径
const toPath = urlOrPath => urlOrPath instanceof URL ? fileURLToPath(urlOrPath) : urlOrPath;

테스트 파일에 디버깅이 오면 여러 소스에서 볼 수 있는 몇 가지 개념이 있습니다. 코드, 따라서 우리의 관심을 끌 가치가 있으며 아래에서 분석됩니다.

import.meta.url

주로 __filename에서 사용되며 __dirname은 ES 모듈에서 사용할 수 없습니다

path.dirname

지정된 경로의 디렉터리 이름을 가져오는 데 사용됩니다

fileURLToPath(import.meta.url)

경로 추출

process.chdir

    更改Node.js进程的当前工作目录，或者在执行失败时抛出异常(例如，如果指定的目录不存在)。

• readPackage方法(异步读取)

export async function readPackage({cwd, normalize = true} = {}) {
// 默认用process.cwd获取当前工作目录，获取工作目录
    cwd = toPath(cwd) || process.cwd();
// 获取package.json相对当前工作目录的绝对路径
    const filePath = path.resolve(cwd, 'package.json');
// 异步读取package.json并解析，fsPromises异步文件模块
    const json = parseJson(await fsPromises.readFile(filePath, 'utf8'));
   // 规范化包元数据
    if (normalize) {
        normalizePackageData(json);
    }


    return json;

}

• readPackageSync方法（同步读取）

export function readPackageSync({cwd, normalize = true} = {}) {
   // 默认用process.cwd获取当前工作目录，获取工作目录
    cwd = toPath(cwd) || process.cwd();
   // 获取package.json相对当前工作目录的绝对路径
    const filePath = path.resolve(cwd, 'package.json');
   // 读取package.json并解析
    const json = parseJson(fs.readFileSync(filePath, 'utf8'));

    // 序列化元数据
    if (normalize) {

        normalizePackageData(json);

    }


    return json;

}

• normalizePackageData作用

序列化前

序列化后

    调试后发现序列化后会生成_id,对应测试用例中的t.truthy(package_._id)

总结

    今天下载并调试了read-pkg的源码，进一步了解了nodejs的path、url、process模块对于读取文件的应用，read-pkg麻雀虽小五脏俱全，完整的测试用例也是我们可以在自己的工具包中借鉴使用的！今天刚好是国庆，追梦人们国庆快乐哇~

更多node相关知识，请访问：nodejs 教程！

위 내용은 팁 공유: package.json 파일을 우아하게 얻기의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!