Lompat ke konten
dokumentasi.id
Commit a27b09d
v1
Star11 rb

Kamu membaca versi lama. Halaman ini hanya bisa dibaca.

3.4

Frameworks, CMS, dan Tools

Tiga bagian terakhir README memuat material yang tidak terikat pada satu bahasa pemrograman atau satu vendor Platforms. Ketiganya ditulis sebagai daftar pipih tanpa sub-bagian ###: ## Frameworks berisi 4 entri (README.md:349-354), ## Content Management System berisi 4 entri (README.md:356-361), dan ## Tools berisi 12 entri (README.md:363-376). Kedua puluh baris itu melengkapi katalog yang dipetakan di Katalog Panduan.

Frameworks dan Content Management System

Kedelapan entri pada dua bagian ini memakai pola paling minimal: hanya [judul](url), tanpa akhiran deskripsi (README.md:349-361). Pola itu berbeda dari aturan kontribusi yang menetapkan format [Title](url) - Description. dan meminta deskripsi singkat untuk setiap entri (contributing.md:22-23).

BagianProyekHost dan path dokumen
FrameworksSymfonysymfony.com/doc/current/contributing/code/standards.html
FrameworksDjangodocs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style
FrameworksVuevuejs.org/style-guide
FrameworksAngularangular.dev/style-guide
Content Management SystemWordPressdeveloper.wordpress.org/coding-standards/wordpress-coding-standards/
Content Management SystemDrupalwww.drupal.org/docs/develop/standards
Content Management SystemMagentodeveloper.adobe.com/commerce/php/coding-standards/
Content Management SystemOctobercmsoctobercms.com/help/guidelines/developer

Dari delapan URL itu hanya Magento yang menyebut bahasa di path-nya, yaitu /commerce/php/; sisanya bergantung pada nama proyek. Vue dan Angular bahkan menunjuk path yang sama, style-guide.

graph TD
  FW["## Frameworks"] -->|"4 entri"| Bare["tautan tanpa deskripsi"]
  CMS["## Content Management System"] -->|"4 entri"| Bare
  TL["## Tools"] -->|"12 entri"| Desc["tautan + Description."]
  Bare -.->|"tidak sesuai aturan"| Rule["Aturan format entri"]
  Desc --> Rule
  style Bare fill:#dc2626,color:#fff
  style Desc fill:#2d7d46,color:#fff
  style Rule fill:#f59e0b,color:#000
%% fig: Pola penulisan entri di tiga bagian terakhir
%% desc: Dua bagian hanya memuat tautan, sedangkan Tools memuat tautan beserta deskripsi sesuai aturan format entri.
Fig. 1: Pola penulisan entri di tiga bagian terakhirDua bagian hanya memuat tautan, sedangkan Tools memuat tautan beserta deskripsi sesuai aturan format entri.

⚠️ Entri tanpa deskripsi memaksa pembaca membuka tautan untuk menilai isinya. Bila menambah entri baru, ikuti model ## Tools yang menyertakan deskripsi singkat setelah tanda -.

⚠️ Urutan ## Frameworks (Symfony, Django, Vue, Angular) dan ## Content Management System (WordPress, Drupal, Magento, Octobercms) tidak mengikuti aturan Links and categories should be sorted alphabetically (contributing.md:26). Pembahasan urutan ada di Format Entri dan Pengurutan.

Tools: perkakas penegak standard

Ke-12 entri ## Tools memakai bentuk lengkap dan semuanya memuat deskripsi setelah tanda - (README.md:363-376). Isinya bukan standard baru, melainkan perkakas yang memeriksa, memperbaiki, atau menghasilkan artefak dari kepatuhan pada sebuah standard.

graph TD
  subgraph SRC["Pemeriksaan sumber"]
    Checkstyle
    ESLint
    JSStd["JavaScript Standard Style"]
    ECS["EasyCodingStandard"]
    Pint["Laravel Pint"]
    Sniff["PHP_CodeSniffer"]
    CSFixer["PHP Coding Standards Fixer"]
    RuboCop
    ShellCheck
  end
  JavaSrc["Java source"]
  JsSrc["JavaScript dan JSX"]
  PhpSrc["PHP source"]
  RubySrc["Ruby source"]
  ShSrc["shell script"]
  Checkstyle --> JavaSrc
  ESLint --> JsSrc
  JSStd --> JsSrc
  ECS --> PhpSrc
  Pint --> PhpSrc
  Sniff --> PhpSrc
  CSFixer --> PhpSrc
  RuboCop --> RubySrc
  ShellCheck --> ShSrc
  JavaSrc --> Pass["Lolos Code Standard"]
  JsSrc --> Pass
  PhpSrc --> Pass
  RubySrc --> Pass
  ShSrc --> Pass
  ConvChangelog["Conventional Changelog"] --> Changelog["changelog dari commit"]
  SemRel["semantic-release"] --> Version["versi dan publishing otomatis"]
  AgentsMd["Agents.md"] --> Agent["instruksi untuk coding agent"]
  style Pass fill:#2d7d46,color:#fff
  style Changelog fill:#8b5cf6,color:#fff
  style Version fill:#8b5cf6,color:#fff
  style Agent fill:#f59e0b,color:#000
%% fig: Perkakas pada Tools dan jenis standard yang ditegakkannya
%% desc: Sembilan perkakas memeriksa sumber per bahasa menuju kelolosan Code Standard, dua perkakas menurunkan changelog dan versi dari commit, dan Agents.md memandu coding agent.
Fig. 2: Perkakas pada Tools dan jenis standard yang ditegakkannyaSembilan perkakas memeriksa sumber per bahasa menuju kelolosan Code Standard, dua perkakas menurunkan changelog dan versi dari commit, dan Agents.md memandu coding agent.
ToolSasaranTindakan yang disebut deskripsi
Agents.mdcoding agentformat terbuka untuk memandu agent
CheckstyleJavamemeriksa kepatuhan pada Code Standard atau set validation rules
Conventional Changelogcommit Gitmenghasilkan changelog
EasyCodingStandardPHPmemakai coding standard apa pun
ESLintJavaScript dan JSXlint yang dapat dipasangi plugin
JavaScript Standard StyleJavaScriptsatu gaya JavaScript
Laravel PintPHPcode style fixer
PHP_CodeSnifferPHPmendeteksi dan memperbaiki pelanggaran standard
PHP Coding Standards FixerPHPmemperbaiki kode agar mengikuti standard
RuboCopRubystatic analyzer dan formatter
semantic-releasecommitversioning dan publishing otomatis
ShellCheckshell scriptstatic analysis

Sebaran sasaran tidak merata: empat tool menyasar PHP (EasyCodingStandard, Laravel Pint, PHP_CodeSniffer, PHP Coding Standards Fixer), dua menyasar JavaScript (ESLint, JavaScript Standard Style), sedangkan Java, Ruby, dan shell script masing-masing hanya punya satu tool (README.md:363-376). Dua tool sisanya tidak memeriksa kode sama sekali: Conventional Changelog dan semantic-release bekerja di atas commit, dan Agents.md berisi instruksi untuk coding agent.

Perkakas di bagian ini adalah materi katalog, bukan pipeline repository ini sendiri. Pemeriksaan yang benar-benar dijalankan saat test dibahas di Quality Gate dan CI.