diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..2a330a5 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,29 @@ +name: CI + +on: + pull_request: + push: + branches: [main] + workflow_call: + +permissions: + contents: read + packages: read + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v7 + with: + persist-credentials: false + - uses: actions/setup-node@v7 + with: + node-version: lts/* + cache: npm + registry-url: https://npm.pkg.github.com + scope: '@devexpress' + - run: npm ci + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - run: npm test diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..3e4b50f --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,50 @@ +name: Release + +on: + push: + tags: ['v*.*.*'] + +permissions: + contents: read + packages: read + +jobs: + test: + uses: ./.github/workflows/ci.yml + + publish: + needs: test + runs-on: ubuntu-latest + permissions: + contents: write + packages: write + steps: + - uses: actions/checkout@v7 + with: + persist-credentials: false + fetch-depth: 0 + - uses: actions/setup-node@v7 + with: + node-version: lts/* + registry-url: https://npm.pkg.github.com + scope: '@devexpress' + + - run: npm ci --ignore-scripts + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Check the tag + run: npx --no vale-style-package-publisher check-release + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - run: npm publish --tag ${{ contains(github.ref_name, '-') && 'next' || 'latest' }} + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Create the GitHub release + run: >- + gh release create "$GITHUB_REF_NAME" --title "$GITHUB_REF_NAME" --generate-notes + ${{ contains(github.ref_name, '-') && '--prerelease' || '' }} + env: + GH_TOKEN: ${{ github.token }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b947077 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules/ +dist/ diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..3f091ca --- /dev/null +++ b/package-lock.json @@ -0,0 +1,195 @@ +{ + "name": "@devexpress/vale-styles", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "@devexpress/vale-styles", + "version": "1.0.0", + "license": "MIT", + "devDependencies": { + "@devexpress/vale-style-package-publisher": "1.0.2", + "@vvago/vale": "3.25.1" + }, + "peerDependencies": { + "@vvago/vale": "~3.25.1" + }, + "peerDependenciesMeta": { + "@vvago/vale": { + "optional": true + } + } + }, + "node_modules/@devexpress/vale-style-package-publisher": { + "version": "1.0.2", + "resolved": "https://npm.pkg.github.com/download/@devexpress/vale-style-package-publisher/1.0.2/0024c4c30b6fd9867307bd92d5c021eb5558559a", + "integrity": "sha512-V6P7TUggS/Xsro0yZfK3fewCWIWYJ0v3xPd83emfkI9XvTujTCqrLGHgnqx2qEiiuLPRT331A0UcQTJI5VzuQg==", + "dev": true, + "license": "UNLICENSED", + "bin": { + "vale-style-package-publisher": "bin/vale-style-package-publisher.mjs" + }, + "engines": { + "node": ">=22" + } + }, + "node_modules/@isaacs/fs-minipass": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@isaacs/fs-minipass/-/fs-minipass-4.0.1.tgz", + "integrity": "sha512-wgm9Ehl2jpeqP3zw/7mo3kRHFp5MEDhqAdwy1fTGkHAwnkGOVsgpvQhL8B5n1qlb01jV3n/bI0ZfZp5lWA1k4w==", + "dev": true, + "license": "ISC", + "dependencies": { + "minipass": "^7.0.4" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@vvago/vale": { + "version": "3.25.1", + "resolved": "https://registry.npmjs.org/@vvago/vale/-/vale-3.25.1.tgz", + "integrity": "sha512-fD0xio58t+dEGpRmILZT3t36H2J3iq0Vw88NYIvxPP51GWzp+miag/rI7F3td0/9YZnlWnd8QoyR3n8PbiuJfw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "dependencies": { + "fs-extra": "^11.4.0", + "tar": "^7.5.15", + "yauzl": "^3.4.0" + }, + "bin": { + "vale": "bin/vale.cjs" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/chownr": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-3.0.0.tgz", + "integrity": "sha512-+IxzY9BZOQd/XuYPRmrvEVjF/nqj5kgT4kEq7VofrDoM1MxoRjEWkrCC3EtLi59TVawxTAn+orJwFQcrqEN1+g==", + "dev": true, + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=18" + } + }, + "node_modules/fs-extra": { + "version": "11.4.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.4.1.tgz", + "integrity": "sha512-KYAb4c9BJQI6QqGKthV68OHe0badztdXJWKo0WtBA9IuCFPTKvE5ZdUBglP833aMjhaSPNO4A5j/EkzZtGlKjA==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=14.14" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/jsonfile": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.1.tgz", + "integrity": "sha512-zwOTdL3rFQ/lRdBnntKVOX6k5cKJwEc1HdilT71BWEu7J41gXIB2MRp+vxduPSwZJPWBxEzv4yH1wYLJGUHX4Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/minipass": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.3.tgz", + "integrity": "sha512-tEBHqDnIoM/1rXME1zgka9g6Q2lcoCkxHLuc7ODJ5BxbP5d4c2Z5cGgtXAku59200Cx7diuHTOYfSBD8n6mm8A==", + "dev": true, + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=16 || 14 >=14.17" + } + }, + "node_modules/minizlib": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-3.1.0.tgz", + "integrity": "sha512-KZxYo1BUkWD2TVFLr0MQoM8vUUigWD3LlD83a/75BqC+4qE0Hb1Vo5v1FgcfaNXvfXzr+5EhQ6ing/CaBijTlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "minipass": "^7.1.2" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/pend": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/pend/-/pend-1.2.0.tgz", + "integrity": "sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg==", + "dev": true, + "license": "MIT" + }, + "node_modules/tar": { + "version": "7.5.22", + "resolved": "https://registry.npmjs.org/tar/-/tar-7.5.22.tgz", + "integrity": "sha512-MFO/QzvtAOmJbkhOaCTvbGcFN9L9b+JunIsDwaKljSOdcLMea3NJ1k9Usz/rjdfSXTq4dfzfeS7W4p4YOAAHeA==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/fs-minipass": "^4.0.0", + "chownr": "^3.0.0", + "minipass": "^7.1.2", + "minizlib": "^3.1.0", + "yallist": "^5.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/yallist": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-5.0.0.tgz", + "integrity": "sha512-YgvUTfwqyc7UXVMrB+SImsVYSmTS8X/tSrtdNZMImM+n7+QTriRXyXim0mBrTXNeqzVF0KWGgHPeiyViFFrNDw==", + "dev": true, + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=18" + } + }, + "node_modules/yauzl": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/yauzl/-/yauzl-3.4.0.tgz", + "integrity": "sha512-jIH9yLR9wqr0wOS0TpBvo/g/2UgZH5qePVbjgRliiF0BYvOZyaBknKsF+x9Iht0O6sqgnB93rCICdOZFecJuDw==", + "dev": true, + "license": "MIT", + "dependencies": { + "pend": "~1.2.0" + }, + "engines": { + "node": ">=12" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..37357d8 --- /dev/null +++ b/package.json @@ -0,0 +1,44 @@ +{ + "name": "@devexpress/vale-styles", + "version": "1.0.0", + "description": "Vale styles that implement the DevExpress Writing Style Guide", + "keywords": [ + "vale", + "vale-style", + "style-guide", + "documentation", + "linter" + ], + "license": "MIT", + "repository": { + "type": "git", + "url": "git+https://github.com/DevExpress/vale-styles.git" + }, + "files": [ + "dist/", + "THIRD_PARTY_NOTICES.md" + ], + "scripts": { + "build": "vale-style-package-publisher build", + "prepack": "npm run build", + "test": "vale-style-package-publisher test" + }, + "peerDependencies": { + "@vvago/vale": "~3.25.1" + }, + "peerDependenciesMeta": { + "@vvago/vale": { + "optional": true + } + }, + "devDependencies": { + "@devexpress/vale-style-package-publisher": "1.0.2", + "@vvago/vale": "3.25.1" + }, + "allowScripts": { + "@vvago/vale": true + }, + "publishConfig": { + "registry": "https://npm.pkg.github.com" + } +} diff --git a/vale/vale/tests/clean.md b/vale/vale/tests/clean.md new file mode 100644 index 0000000..64d584e --- /dev/null +++ b/vale/vale/tests/clean.md @@ -0,0 +1,19 @@ +# Bind the Grid to Data + +This sample must not trigger any rule. The smoke test (`npm test`) fails if Vale reports an alert for this file. + +The Grid displays data from a local array or a remote service. To bind the Grid to data, set the `dataSource` property: + +```js +const grid = new Grid(element, { dataSource: orders }); +``` + +## Data Source Types + +The Grid supports the following data source types: + +- A local array of objects. +- A remote service that returns JSON. +- A custom store that loads data on demand. + +Refer to the following topic for more information: [Data Binding](data-binding.md).