@sanity/schema-lint 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Sanity.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,131 @@
+# @sanity/schema-lint
+
+Sanity schema linter for catching common issues and enforcing best practices.
+
+## Installation
+
+```bash
+npm install @sanity/schema-lint
+# or
+pnpm add @sanity/schema-lint
+```
+
+## Usage
+
+### Programmatic API
+
+```typescript
+import { lint } from '@sanity/schema-lint'
+
+// Lint a schema type definition
+const result = lint({
+  name: 'post',
+  type: 'document',
+  fields: [{ name: 'title', type: 'string' }],
+})
+
+for (const finding of result.findings) {
+  console.log(`${finding.ruleId}: ${finding.message}`)
+}
+```
+
+### Lint Multiple Schemas
+
+```typescript
+import { lintSchemas } from '@sanity/schema-lint'
+
+const schemas = [
+  { name: 'post', type: 'document', fields: [...] },
+  { name: 'author', type: 'document', fields: [...] },
+]
+
+const results = lintSchemas(schemas)
+```
+
+### With Configuration
+
+```typescript
+import { lint } from '@sanity/schema-lint'
+
+const result = lint(schema, {
+  config: {
+    rules: {
+      'missing-description': false, // Disable rule
+      'missing-icon': { enabled: true, severity: 'warning' },
+    },
+  },
+})
+```
+
+## Rules
+
+### Core Rules
+
+| Rule                      | Severity | Description                                    |
+| ------------------------- | -------- | ---------------------------------------------- |
+| `missing-define-type`     | warning  | Schema should use `defineType()`               |
+| `missing-define-field`    | warning  | Fields should use `defineField()`              |
+| `missing-icon`            | warning  | Document types should have an icon             |
+| `missing-title`           | info     | Types should have a title                      |
+| `missing-description`     | info     | Types should have a description                |
+| `presentation-field-name` | warning  | Avoid field names that clash with presentation |
+
+### Field Rules
+
+| Rule                          | Severity | Description                                |
+| ----------------------------- | -------- | ------------------------------------------ |
+| `boolean-instead-of-list`     | info     | Consider list instead of boolean           |
+| `missing-slug-source`         | warning  | Slug fields should have a source           |
+| `missing-required-validation` | info     | Consider adding required validation        |
+| `reserved-field-name`         | error    | Field name conflicts with Sanity internals |
+
+### Array & Reference Rules
+
+| Rule                        | Severity | Description                                  |
+| --------------------------- | -------- | -------------------------------------------- |
+| `array-missing-constraints` | warning  | Arrays should have min/max constraints       |
+| `heading-level-in-schema`   | info     | Heading levels belong in content, not schema |
+| `unnecessary-reference`     | info     | Reference could be simplified                |
+
+## API Reference
+
+### `lint(schema: SchemaType, options?: LintOptions): LintResult`
+
+Lint a single schema type definition.
+
+```typescript
+interface LintOptions {
+  config?: SchemaLinterConfig
+}
+
+interface LintResult {
+  schema: SchemaType
+  findings: Finding[]
+}
+```
+
+### `lintSchemas(schemas: SchemaType[], options?: LintOptions): LintResult[]`
+
+Lint multiple schema type definitions.
+
+### Rules Array
+
+```typescript
+import { rules } from '@sanity/schema-lint'
+
+// All 13 rules
+console.log(rules.map((r) => r.id))
+```
+
+### Individual Rule Imports
+
+```typescript
+import { missingIcon, reservedFieldName } from '@sanity/schema-lint'
+
+// Use individual rules
+const customRules = [missingIcon, reservedFieldName]
+```
+
+## License
+
+MIT

package/dist/chunk-7D4SUZUM.js

@@ -0,0 +1,38 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var __commonJS = (cb, mod) => function __require2() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+export {
+  __require,
+  __commonJS,
+  __toESM
+};
+//# sourceMappingURL=chunk-7D4SUZUM.js.map

package/dist/chunk-7D4SUZUM.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/index.d.ts

@@ -0,0 +1,133 @@
+import { S as SchemaType, a as SchemaRule, b as SchemaLinterConfig } from './types-C3OVyCP6.js';
+export { c as SchemaField, e as SchemaRuleConfig, d as SchemaRuleContext } from './types-C3OVyCP6.js';
+import { Finding } from '@sanity/lint-core';
+
+interface LintOptions {
+    /** Specific rules to run (if not provided, runs all) */
+    rules?: SchemaRule[];
+    /** Configuration for rules */
+    config?: SchemaLinterConfig;
+    /** File path for context */
+    filePath?: string;
+}
+interface LintResult {
+    /** The findings from all rules */
+    findings: Finding[];
+}
+/**
+ * Lint a schema type definition
+ *
+ * @param schema - The schema to lint
+ * @param allRules - All available rules
+ * @param options - Lint options
+ * @returns Lint result with findings
+ */
+declare function lint(schema: SchemaType, allRules: SchemaRule[], options?: LintOptions): LintResult;
+/**
+ * Lint multiple schema types
+ */
+declare function lintSchemas(schemas: SchemaType[], allRules: SchemaRule[], options?: LintOptions): LintResult;
+
+/**
+ * Rule: missing-define-type
+ *
+ * Schema types should be wrapped with defineType() for proper type inference
+ * and Studio integration.
+ */
+declare const missingDefineType: SchemaRule;
+
+/**
+ * Rule: missing-define-field
+ *
+ * Fields should be wrapped with defineField() for proper type inference.
+ */
+declare const missingDefineField: SchemaRule;
+
+/**
+ * Rule: missing-icon
+ *
+ * Document and object types should have an icon for better Studio UX.
+ */
+declare const missingIcon: SchemaRule;
+
+/**
+ * Rule: missing-title
+ *
+ * Schema types should have a human-readable title.
+ */
+declare const missingTitle: SchemaRule;
+
+/**
+ * Rule: missing-description
+ *
+ * Fields should have descriptions to help content editors.
+ */
+declare const missingDescription: SchemaRule;
+
+/**
+ * Rule: presentation-field-name
+ *
+ * Field names should be semantic, not presentation-focused.
+ */
+declare const presentationFieldName: SchemaRule;
+
+/**
+ * Rule: boolean-instead-of-list
+ *
+ * Some boolean fields might be better represented as a string field
+ * with options.list for future expandability.
+ */
+declare const booleanInsteadOfList: SchemaRule;
+
+/**
+ * Rule: missing-slug-source
+ *
+ * Slug fields should have options.source for auto-generation.
+ */
+declare const missingSlugSource: SchemaRule;
+
+/**
+ * Rule: missing-required-validation
+ *
+ * Critical fields like title, name, and slug should have validation rules.
+ */
+declare const missingRequiredValidation: SchemaRule;
+
+/**
+ * Rule: reserved-field-name
+ *
+ * Field names starting with underscore are reserved by Sanity.
+ */
+declare const reservedFieldName: SchemaRule;
+
+/**
+ * Rule: array-missing-constraints
+ *
+ * Array fields should have constraints (min, max, unique) to prevent
+ * unbounded data and ensure data quality.
+ */
+declare const arrayMissingConstraints: SchemaRule;
+
+/**
+ * Rule: heading-level-in-schema
+ *
+ * Heading levels (h1, h2, etc.) should be computed dynamically in components,
+ * not stored in the schema.
+ */
+declare const headingLevelInSchema: SchemaRule;
+
+/**
+ * Rule: unnecessary-reference
+ *
+ * Warns about reference fields that might be better as embedded objects.
+ * References are great for shared content, but embedded objects are simpler
+ * for content that's specific to a single document type.
+ */
+declare const unnecessaryReference: SchemaRule;
+
+/**
+ * All available schema lint rules (13 total)
+ */
+declare const rules: SchemaRule[];
+
+export { type LintOptions, type LintResult, SchemaLinterConfig, SchemaRule, SchemaType, arrayMissingConstraints, booleanInsteadOfList, headingLevelInSchema, lint, lintSchemas, missingDefineField, missingDefineType, missingDescription, missingIcon, missingRequiredValidation, missingSlugSource, missingTitle, presentationFieldName, reservedFieldName, rules, unnecessaryReference };