shingangan / _nuxt-markuplint

Markuplint module for Nuxt.

🔈 rebuilt in a separate Repository: nuxt-markuplint

(Archive) Nuxt Markuplint

Integrate Markuplint into your Nuxt application.

👀 Features

• 👌  Zero configuration to start
• 🚠  Bar
• 🌲  Baz

🚀 Quick Setup

Installation

# Using pnpm
pnpm add -D @shinGangan/nuxt-markuplint

# Using npm
npm i -D @shinGangan/nuxt-markuplint

# Using yarn
yarn add -D @shinGangan/nuxt-markuplint

Add Module to nuxt.config.{ts,js}

{
  modules: [
    "@shinGangan/markuplint"
  ],
  markuplint: {
    // Options
  }
}

WIP: Contributing

License

This repository is licensed under the MIT License.

_nuxt-markuplint's Issues

docs: Getting Started - Setup

内容

• Setupページを実装する

項目

• インストールし、http://localhost:3000 実施するまでの手順

refactor: refactor renovate.json

Context

• refactor renovate.json
  • extends @shinGangan/renovate-config/markuplint

Note

OSSとして公開するのであれば本リポジトリ内で設定したほうが良い説もある。

docs: Examples - Basic Usage

内容

• Basic Usageページを作成する

項目

• サンドボックスを用意する
• リンターエラーを意図的に埋め込む

docs: Module Docus

Description

モジュールドキュメントを作成する

Env

• uses Docus

TODO

• #3
• #8
• #6
• #7
• #15
• #16
• #17

参考

• https://github.com/nuxt-themes/docus#they-are-using-it-
• https://content.nuxt.com/
• https://v8.i18n.nuxtjs.org/
• https://image.nuxt.com/
• https://tailwindcss.nuxtjs.org/
• https://storybook.nuxtjs.org/
• https://github.com/wattanx/nuxt-pandacss/tree/81e9e333fdd5f13ac9dcb38fe61b134a75b43f8e/docs
• Webのドキュメントサイトを作るためにDocusに入門してみた

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: File contents are invalid JSON but parse using JSON5. Support for this will be removed in a future release so please change to a support .json5 file name or ensure correct JSON syntax.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): update devdependency vitest to ^1.3.1

Detected dependencies

npm

docs/package.json

• @nuxt-themes/docus ^1.15.0
• nuxt ^3.10.2

package.json

• @markuplint/vue-parser ^4.1.1
• @markuplint/vue-spec ^4.0.2
• @nuxt/kit ^3.10.2
• markuplint ^4.1.1
• @markuplint/ml-config ^4.1.1
• @nuxt/eslint-config ^0.2.0
• @nuxt/module-builder ^0.5.5
• @nuxt/schema ^3.10.2
• @nuxt/test-utils ^3.11.0
• @types/node ^20.11.19
• changelogen ^0.5.5
• consola ^3.2.3
• eslint ^8.56.0
• nuxt ^3.10.2
• vitest ^1.3.0

playground/package.json

---

• Check this box to trigger a request for Renovate to run again on this repository

build: Build a environment.

TODO

• #3
• #10
• #11
• #4

MOD-001: Designing modules (v0.1.0)

MOD-001: Designing modules (v0.1.0)

• Author: @shinGangan
• created: 2023/11/05
• updated: 2023/12/11

Status

Accepted

Context

ref: markuplint

• https://markuplint.dev/ja/
• https://github.com/markuplint/markuplint

Decisions

• Designの方向性でv0.1.0を作成していく。
• v0.1.0以降の拡張性、ドキュメントの拡充についてはpatchバージョンで追加する方針

Consequences

• まず動くものを、利用できるものを提供することでユーザーの認知を獲得できる
• ユーザー側の利用方法を収集するために良い決定である。意見などを踏まえてv0.2.0のADRを作成する

Design

欲しいオプション

• configPath
  • 設定ファイルの場所
  • type ConfigPath = string?
  • rulesが肥大化する場合はconfigPathで設定 + gitで管理した方が良い。しかし、デフォルトルールで良い場合は.markuplintrcをModule側に内包しても良いのではないかと考えている
• markuplintの各種プロパティ設定
  • configPath未設定の場合はNuxt Moduleで設定した各種プロバティ内容を反映させる
  • ref: https://markuplint.dev/ja/docs/configuration/properties

example

using configPath

// nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    "@shinGangan/nuxt-markuplint",
  ],
  markuplint: {
    /**
     * @default "<buildDir>/.markuplintrc.json"
     * @description <buildDir> のデフォルトは`.nuxt`
     */
    configPath: "configs/markuplint.config.json",
  }
});

no using configPath

specs、parser、extendsはデフォルト値である。下記はサンプルのため明示しているが、デフォルト利用の場合はmarkuplint: {}すら不要である。

// nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    "@shinGangan/nuxt-markuplint",
  ],
  markuplint: {
    specs: {
      "\\.vue$": "@markuplint/vue-spec"
    },
    parser: {
      "\\.vue$": "@markuplint/vue-parser"
    },
    extends: [ "markuplint:recommended" ]
  }
});

chore: ESLint

WIP: TODO

以下を追加する。

• [ ]

docs: Markuplint - Config

docs: i18n対応

内容

• nuxt/i18n 対応を行う

対応理由

このようなドキュメントは主に英語ドキュメントしか用意されない傾向にある。しかし、ドキュメントが英語のみというのは初学者の参入障壁を高める傾向にある。markuplintは初学者にこそ使ってもらいたいリンターであり、初学者の参入障壁は極力下げておきたい。

また、markuplintの作者およびコミュニティは主に日本を中心に形成されている。

上記の理由より日本語対応はあった方が好ましいと考えている。

調査内容

• nuxt/content(for Nuxt3)におけるi18n対応の公式情報
• nuxt/i18nの導入
  • これはそんなに時間かからないはず。過去の対応イシュー: shinGangan/create-nuxt3-app#20
• 本Docsにおいて切り替えの実験

docs: Introduction

内容

• Introductionを作成する

項目について

• ヒーローヘッダーには以下を配置する
  • terminal -> pnpmだけで良い
  • nuxt.config.ts
• カード載せたい

build: Built a environment for Docus

内容

• Docusの環境を構築する
• pnpm workspaceでmonorepo管理を行う

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: .github/renovate.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error near ",
],

docs: Getting Started - Options

内容

• Optionsページを作成する

項目

• nuxt/storybookやnuxt/tailwindを参考にして作成する
• 基本的にはmarkuplint提供の型情報をextendsする
  • こちらの説明についてはmarkuplint/configのページで説明する
  • 本ページは本モジュール固有のオプションのみを説明する

担当者へ

• オプション内容については今後要検討である。そのため、ページの雛形さえあれば良いです

chore: ESLint Flat Config

Description

ESLint Flat Configに対応する

build: Add nuxt-vitest

内容

• nuxt-vitestを導入する