https://github.com/korosuke613/zenn-metadata-updater

Update metadata in Zenn markdown file for npm.
https://github.com/korosuke613/zenn-metadata-updater

npm-package zenn

Last synced: 5 months ago
JSON representation

Update metadata in Zenn markdown file for npm.

• Host: GitHub
• URL: https://github.com/korosuke613/zenn-metadata-updater
• Owner: korosuke613
• License: mit
• Created: 2021-02-20T16:15:43.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-29T13:43:10.000Z (about 2 years ago)
• Last Synced: 2024-05-02T06:00:03.721Z (about 2 years ago)
• Topics: npm-package, zenn
• Language: TypeScript
• Homepage:
• Size: 1.09 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# zenn-metadata-updater

[![npm version](https://badge.fury.io/js/zenn-metadata-updater.svg)](https://badge.fury.io/js/zenn-metadata-updater)

Update metadata in Zenn markdown file for npm.

## Install

```console

npm install zenn-metadata-updater

```

## Usage

hoge-zenn-article.md

```markdown

---

title: "Productivity Weekly (20xx-xx-xx号)"

emoji: "😇"

type: "idea"

topics: ["ProductivityWeekly", "生産性向上"]

published: false

---

# Content start

```

### Update metadata

#### Single param

```ts

const markdownPath = "hoge-zenn-article.md"

const markdown = readFileSync(markdownPath);

const updater = new Updater();

await updater.load(markdown);

updater.updateProperty("published", true);

console.log(updater.getUpdatedContent());

/*

---

title: "Productivity Weekly (20xx-xx-xx号)"

emoji: "😇"

type: "idea"

topics: ["ProductivityWeekly", "生産性向上"]

published: false

---

# Content start

 */

```

#### Multi param

```ts

const markdownPath = "hoge-zenn-article.md"

const markdown = readFileSync(markdownPath);

const updater = new Updater();

await updater.load(markdown);

const param: ZennMetadata = {

  title: "hoge",

  emoji: "㊙️",

  type: "tech",

  topics: ["fuga", "bar"],

  published: false,

};

updater.updateProperty(param);

console.log(updater.getUpdatedContent());

/*

---

title: "hoge"

emoji: "㊙️"

type: "tech"

topics: ["fuga", "bar"]

published: false

---

# Content start

 */

```

### Validate metadata

invalid-zenn-article.md

```markdown

---

title: ""

emoji: ""

type: "hoge"

topics: ["ProductivityWeekly", "生産性向上"]

published: ""

---

# Content start

```

```ts

const markdownPath = "invalid-zenn-article.md"

const markdown = readFileSync(markdownPath);

const updater = new Updater();

updater.load(markdown);

updater.validateProperty();

// Invalid metadata: type, emoji, title, boolean

```