javascript-style

作者: contentstack

JavaScript 和 TypeScript 声明风格,适用于库、webpack、类型——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 的更多技能

brand-kit-assistant
contentstack
就Contentstack Brand Kit的概念、设置、治理及品牌化AI生成向用户提供建议。将API相关任务路由到正确的Brand Kit功能或…
official
cms-assets
contentstack
为开发人员提供关于在Contentstack中组织、交付和转换资产的建议。涵盖文件夹结构、Image Delivery API转换、发布……
official
cms-branches-aliases
contentstack
指导开发者使用Contentstack分支进行隔离的内容开发,并使用别名实现零停机的内容部署。涵盖分支策略、…
official
cms-data-modeling-best-practices
contentstack
指导开发者在Contentstack中使用最简单可复用的结构来建模内容。该技能解释了何时使用内容类型、引用、全局…
official
cms-entries
contentstack
为开发者提供关于查询、本地化、版本管理、发布和构建Contentstack条目的建议,以实现高效交付。重点关注CDA的使用、引用……
official
cms-environments-publishing
contentstack
为开发人员提供关于配置环境、发布内容、使用交付和预览令牌、利用Sync API以及了解CDN和…的建议
official
cms-live-preview-visual-builder-support-assistant
contentstack
诊断并指导Contentstack Live Preview和Visual Builder的实施。追踪预览上下文,识别损坏的契约,并推荐…
official
cms-localization
contentstack
Advise developers on Contentstack localization: language setup, fallback chains, localized vs unlocalized entries, non-localizable fields, and multi-locale…
official