javascript-style

作者: contentstack

JavaScript 與 TypeScript 宣告風格,適用於 lib、webpack、types — ESLint 標準、模組、JSDoc。

npx skills add https://github.com/contentstack/contentstack-management-javascript --skill javascript-style

JavaScript & types – Contentstack Management JavaScript SDK

When to use

  • Editing lib/**/*.js, webpack/**/*.js, types/**, or root *.mjs.
  • Matching ESLint standard style and public JSDoc for npm consumers.

Instructions

Runtime & modules

  • Source is ES modules under lib/ (import / export). Builds target Node and browsers via Babel + Webpack (package.json scripts).
  • types/ holds public TypeScript declarations for npm; keep aligned with lib/ JSDoc and exports.

Style & tooling

  • ESLint uses eslint-config-standard and @babel/eslint-parser; match semicolon-free standard style and two-space indentation as in existing lib/ files.
  • Environment: ESLint es2020; test/**/*.js may relax rules via overrides in .eslintrc.js.

Patterns

  • Prefer named exports where the codebase already does; default exports for factories (contentstackClient, HTTP client factory).
  • JSDoc (@memberof, @func, @param, @returns, @example) on public API, consistent with lib/contentstack.js and lib/contentstackClient.js.
  • Dependencies: lodash, axios, qs, @contentstack/utils — follow existing import paths (including .js suffixes where used).

Logging

  • Avoid noisy console.log in library code except via existing logHandler / patterns in lib/core/contentstackHTTPClient.js.
  • Never log full authtoken, management tokens, or passwords.

來自 contentstack 的更多技能

cms-assets
contentstack
為開發人員提供有關在Contentstack中組織、交付和轉換資產的建議。涵蓋資料夾結構、Image Delivery API轉換、發佈……
cms-branches-aliases
contentstack
為開發人員提供使用 Contentstack 分支進行隔離內容開發以及使用別名實現零停機內容部署的建議。涵蓋分支策略,…
cms-data-modeling-best-practices
contentstack
引導開發人員在Contentstack中使用最簡單的可重用結構來建模內容。此技能說明何時使用內容類型、引用、全域…
cms-live-preview-visual-builder-support-assistant
contentstack
診斷並指導 Contentstack Live Preview 和 Visual Builder 的實作。追蹤預覽上下文,識別中斷的合約,並建議…
cms-releases
contentstack
指導開發人員使用 Contentstack Releases 進行協調、原子化的內容部署。涵蓋版本建立、項目管理、分階段部署等內容。
cms-roles-permissions
contentstack
為開發人員提供關於在Contentstack中設計角色、權限、團隊和Token存取權限的建議。解釋內建角色、自訂角色、權限合併等。
cms-taxonomy
contentstack
為開發人員提供關於使用 Contentstack Taxonomy 進行結構化、階層式內容分類及傳遞端篩選的建議。涵蓋 taxonomy 與 tags 的比較,…
cms-tokens-authentication
contentstack
為開發人員提供建議,協助他們為前端、後端、自動化及第三方應用程式使用情境選擇正確的Contentstack驗證方法與權杖類型。…