https://github.com/wmfs/cardscript-schema

https://github.com/wmfs/cardscript-schema

cardscript tymly

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wmfs/cardscript-schema
• Owner: wmfs
• License: mit
• Created: 2019-01-18T08:37:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-05-02T01:16:46.000Z (23 days ago)
• Last Synced: 2025-05-02T02:28:05.180Z (23 days ago)
• Topics: cardscript, tymly
• Language: JavaScript
• Size: 251 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cardscript-schema

[![Tymly Cardscript](https://img.shields.io/badge/tymly-cardscript-blue.svg)](https://tymly.io/)

[![CircleCI](https://circleci.com/gh/wmfs/cardscript-schema.svg?style=svg)](https://circleci.com/gh/wmfs/cardscript-schema)

[![npm (scoped)](https://img.shields.io/npm/v/@wmfs/cardscript-schema.svg)](https://www.npmjs.com/package/@wmfs/cardscript-schema) 

[![codecov](https://codecov.io/gh/wmfs/cardscript-schema/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/cardscript-schema) 

[![CodeFactor](https://www.codefactor.io/repository/github/wmfs/cardscript-schema/badge)](https://www.codefactor.io/repository/github/wmfs/cardscript-schema) 

[![Dependabot badge](https://img.shields.io/badge/Dependabot-active-brightgreen.svg)](https://dependabot.com/) 

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) 

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) 

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly/blob/master/packages/concrete-paths/LICENSE)

> Contains a JSON Schema for Cardscript, along with a validation utility.

## Install

```bash

$ npm install cardscript-schema --save

```

## Usage

```javascript

const cardscriptSchema = require('@wmfs/cardscript-schema')

const result = cardscriptSchema.validateForm(

  {

    "type": "AdaptiveCard",

    "body": [

      {

        "type": "TextBlock",

        "text": "Change me!",

        "color": "attention",

        "horizontalAlignment": "center"

      }

    ],

    "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",

    "version": "1.0"

  }

)

if (result.elementsValid) {

  // All is well!!

} else {

  // Do something with result.errors array.

}

```

## Testing

```bash

$ npm test

```

## License

[MIT](https://github.com/wmfs/cardscript/blob/master/LICENSE)