steedos-validate-package

Name: steedos-validate-package
Availability: InStock
Author: Steedos

Validate Steedos package structure and metadata with JSON reports for CI.

1.6k|413|Updated Mar 4, 2019

Search Tags:#automation #yaml #validate #lint #package #ci #steedos

Ready to run

npx skills add https://github.com/steedos/steedos-platform --skill steedos-validate-package

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: steedos-validate-package
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-validate-package
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-validate-package

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill validates Steedos packages after creation or modification, ensuring the project adheres to Steedos conventions (e.g., package.json exists with main: package.service.js and the validator checks packageLoader, namespace, and packageInfo).

Core Features & Use Cases

Validates package structure and metadata for objects, fields, triggers, functions, listviews, permissions, apps, and tabs.
Enforces required fields, naming, and placement rules to catch issues before deployment or CI.
Provides a machine-readable report suitable for CI pipelines to surface errors early.

Quick Start

Run the validator against a Steedos package using yarn validate <path> or npx @steedos/validate to generate a JSON report for CI.

Frequently Asked Questions about steedos-validate-package

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I validate a Steedos package structure before deployment?▼

To validate a Steedos package structure, run `yarn validate` or `npx @steedos/validate` to check that package.json includes main: package.service.js and verifies packageLoader, namespace, and packageInfo. This ensures your package adheres to Steedos conventions before deployment.

What metadata files does the Steedos validator check for compliance?▼

The Steedos validator checks metadata files for objects, fields, triggers, functions, listviews, permissions, apps, and tabs. It enforces naming, type, and placement rules to ensure all metadata files follow the required structure and catch issues early.

Can I generate a JSON validation report for Steedos packages in CI pipelines?▼

Yes, you can generate a machine-readable JSON validation report for CI pipelines by running the validator with the `--json` option via `npx @steedos/validate --json`. This report surfaces structural errors early in your CI workflow.

Why does my Steedos package fail validation after modification?▼

Your Steedos package fails validation because the validator enforces required fields, naming conventions, and placement rules for metadata. It checks that package.json contains main: package.service.js and verifies packageLoader, namespace, and packageInfo are present.

What is the best way to lint Steedos package metadata for errors?▼

The best way to lint Steedos package metadata is using the Steedos validator, which enforces naming, type, and placement rules across objects, fields, triggers, functions, listviews, permissions, apps, and tabs to catch compliance issues before deployment.

Do I need specific dependencies installed to run Steedos package validation?▼

No specific dependencies are required to run Steedos package validation. You can execute the validator directly using `npx @steedos/validate` without installing additional packages, or add it to your project via `yarn validate`.