Skip to content

i18n(ja):enforce japanese writing style [i18nIgnore] #11931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 30, 2025

Conversation

jp-knj
Copy link
Contributor

@jp-knj jp-knj commented Jun 23, 2025

Description (required)

This PR runs textlint --fix across our documentation and mdx files using only the preset-ja-spacing rule. It configures .textlintrc.json to enforce Japanese spacing conventions, correcting full-width and half-width spaces around punctuation and between Japanese and Latin characters to align with the official Japanese writing guide.

{
  "rules": {
    "preset-ja-spacing": true
  }
}

Japanese writing guide.

### 英数字前後のスペース
日本語の文章を書く際には、日本語と英数字の間にはスペースを挿入しない方針を採用しています。
また、インラインコード(`code`)を用いる場合もその前後にはスペースを挿入しません。
- **適合例**
- TypeScriptコードを書く予定がある場合は、Astroの`strict`または`strictest`テンプレートを使用することをおすすめします。3種類の設定用テンプレートは[astro/tsconfigs/](https://github.com/withastro/astro/blob/main/packages/astro/tsconfigs/)で確認できます。
- **不適合例**
- TypeScript コードを書く予定がある場合は、Astro の `strict` または `strictest` テンプレートを使用することをおすすめします。3 種類の設定用テンプレートは [astro/tsconfigs/](https://github.com/withastro/astro/blob/main/packages/astro/tsconfigs/) で確認できます。
ただし、日本語文脈ではない文章においてはこの限りではありません。例えば、次の文章は英語文脈であり、英単語前後のスペースを除去してはいけません。
- **適合例**
- 作る means “make” in Japanese.
この方針を採用している理由は次の通りです。
読みやすさのために、日本語文章であっても英数字前後にスペースを挿入する方針を採用することはしばしばあります。それは、長らく日本語文章内の英数字前後の余白を論理的に制御する方法がなかったためです。

Related issues & labels (optional)

  • Closes #
  • Suggested label: i18n

Copy link

netlify bot commented Jun 23, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 744354f
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/6862cd965fb6fb00088021e6
😎 Deploy Preview https://deploy-preview-11931--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Jun 23, 2025
@astrobot-houston
Copy link
Contributor

astrobot-houston commented Jun 23, 2025

Lunaria Status Overview

🌑 This pull request will not trigger status changes.

Learn more

Lunaria automatically ignores changes on specific PRs by adding a ignored keyword in its title. Found: i18nIgnore.

You can change this by either removing the keyword above from the PR's title, or modifying the ignoreKeywords property in your Lunaria configuration file.

Tracked Files

Note

The notes below indicate what would happen if the pull request is merged when triggering status changes. Since a ignored keyword was found in the PR's title, the status changes indicated below won't be applied.

File Note
ja/basics/astro-pages.mdx Localization changed, will be marked as complete.
ja/guides/astro-db.mdx Localization changed, will be marked as complete.
ja/guides/content-collections.mdx Localization changed, will be marked as complete. 🔄️
ja/guides/deploy/aws.mdx Localization changed, will be marked as complete.
ja/guides/deploy/google-cloud.mdx Localization changed, will be marked as complete.
ja/guides/deploy/vercel.mdx Localization changed, will be marked as complete.
ja/guides/ecommerce.mdx Localization changed, will be marked as complete.
ja/guides/imports.mdx Localization changed, will be marked as complete.
ja/guides/integrations-guide/cloudflare.mdx Localization changed, will be marked as complete.
ja/guides/integrations-guide/db.mdx Localization changed, will be marked as complete.
ja/guides/markdown-content.mdx Localization changed, will be marked as complete.
ja/guides/migrate-to-astro/from-create-react-app.mdx Localization changed, will be marked as complete.
ja/guides/migrate-to-astro/from-gatsby.mdx Localization changed, will be marked as complete.
ja/guides/routing.mdx Localization changed, will be marked as complete.
ja/guides/styling.mdx Localization changed, will be marked as complete.
ja/guides/upgrade-to/v2.mdx Localization changed, will be marked as complete.
ja/guides/view-transitions.mdx Localization changed, will be marked as complete.
ja/install-and-setup.mdx Localization changed, will be marked as complete.
ja/recipes/sharing-state-islands.mdx Localization changed, will be marked as complete.
ja/reference/astro-syntax.mdx Localization changed, will be marked as complete.
ja/reference/cli-reference.mdx Localization changed, will be marked as complete.
ja/reference/configuration-reference.mdx Localization changed, will be marked as complete.
ja/reference/directives-reference.mdx Localization changed, will be marked as complete.
ja/tutorial/2-pages/2.mdx Localization changed, will be marked as complete.
ja/tutorial/4-layouts/1.mdx Localization changed, will be marked as complete.
ja/tutorial/6-islands/3.mdx Localization changed, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@jp-knj jp-knj changed the title enforce japanese writing style i18n(ja):enforce japanese writing style Jun 23, 2025
@jp-knj jp-knj changed the title i18n(ja):enforce japanese writing style i18n(ja):enforce japanese writing style Jun 23, 2025
@yanthomasdev yanthomasdev changed the title i18n(ja):enforce japanese writing style i18n(ja):enforce japanese writing style [i18nIgnore] Jun 30, 2025
Copy link
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good job!

@yanthomasdev yanthomasdev merged commit 8afc154 into withastro:main Jun 30, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants