@sqldoc/ns-lint 0.0.1

package/package.json

@@ -0,0 +1,30 @@
+{
+  "type": "module",
+  "name": "@sqldoc/ns-lint",
+  "version": "0.0.1",
+  "description": "Lint namespace for sqldoc -- @lint.ignore tag for suppressing lint rules",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "files": [
+    "src",
+    "package.json"
+  ],
+  "peerDependencies": {
+    "@sqldoc/core": "0.0.1"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.0",
+    "@sqldoc/core": "0.0.1"
+  },
+  "scripts": {
+    "test": "vitest run"
+  }
+}

package/src/__tests__/lint.test.ts

@@ -0,0 +1,31 @@
+import { describe, expect, it } from 'vitest'
+import plugin from '../index'
+
+describe('ns-lint plugin', () => {
+  it('exports apiVersion === 1', () => {
+    expect(plugin.apiVersion).toBe(1)
+  })
+
+  it('exports name === "lint"', () => {
+    expect(plugin.name).toBe('lint')
+  })
+
+  it('has an ignore tag definition', () => {
+    expect(plugin.tags).toHaveProperty('ignore')
+  })
+
+  it('ignore tag targets tables, columns, views, and functions', () => {
+    expect(plugin.tags.ignore.targets).toEqual(['table', 'column', 'view', 'function'])
+  })
+
+  it('ignore tag takes two positional string args', () => {
+    const args = plugin.tags.ignore.args as Array<{ type: string }>
+    expect(args).toHaveLength(2)
+    expect(args[0].type).toBe('string')
+    expect(args[1].type).toBe('string')
+  })
+
+  it('does not produce SQL output (no onTag)', () => {
+    expect(plugin.onTag).toBeUndefined()
+  })
+})

package/src/index.ts

@@ -0,0 +1,15 @@
+import type { NamespacePlugin } from '@sqldoc/core'
+
+const plugin: NamespacePlugin = {
+  apiVersion: 1,
+  name: 'lint',
+  tags: {
+    ignore: {
+      description: 'Suppress a lint rule on this object. Reason is mandatory.',
+      targets: ['table', 'column', 'view', 'function'],
+      args: [{ type: 'string' }, { type: 'string' }],
+    },
+  },
+}
+
+export default plugin