@platformos/platformos-check-common 0.0.17 → 0.0.18

package/src/checks/metadata-params/extract-undefined-variables.spec.ts

@@ -1,115 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { extractUndefinedVariables } from './extract-undefined-variables';
-
-describe('extractUndefinedVariables', () => {
-  it('should return variables used but not defined', () => {
-    const source = `{% liquid
-      assign b = a
-    %}
-    {{ b }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal(['a']);
-  });
-
-  it('should not include assigned variables', () => {
-    const source = `{% assign x = 1 %}{{ x }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should not include captured variables', () => {
-    const source = `{% capture x %}hello{% endcapture %}{{ x }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should not include for loop variables', () => {
-    const source = `{% for item in items %}{{ item }}{% endfor %}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal(['items']);
-  });
-
-  it('should not include forloop variable', () => {
-    const source = `{% for item in items %}{{ forloop.index }}{% endfor %}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal(['items']);
-  });
-
-  it('should handle function result variables', () => {
-    const source = `{% function res = 'my_partial' %}{{ res }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should handle graphql result variables', () => {
-    const source = `{% graphql res = 'my_query' %}{{ res }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should handle inline graphql result variables', () => {
-    const source = `{% graphql res %}{ users { id } }{% endgraphql %}{{ res }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should handle parse_json result variables', () => {
-    const source = `{% parse_json data %}{"a":1}{% endparse_json %}{{ data }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should not include global objects', () => {
-    const source = `{{ context.session }}`;
-    const result = extractUndefinedVariables(source, [
-      'context',
-      'null',
-      'true',
-      'false',
-      'blank',
-      'empty',
-    ]);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should deduplicate results', () => {
-    const source = `{{ a }}{{ a }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal(['a']);
-  });
-
-  it('should return empty array if source fails to parse', () => {
-    const source = `{% invalid unclosed`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should handle increment/decrement as definitions', () => {
-    const source = `{% increment counter %}{{ counter }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should handle background file-based result variables', () => {
-    const source = `{% background my_job = 'some_partial' %}{{ my_job }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal([]);
-  });
-
-  it('should handle inline background tag without job_id', () => {
-    const source = `{% background source_name: 'my_task' %}echo "hello"{% endbackground %}{{ my_job }}`;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal(['my_job']);
-  });
-
-  it('should not include doc param names', () => {
-    const source = `
-      {% doc %}
-        @param {String} name - a name
-      {% enddoc %}
-      {{ name }}
-    `;
-    const result = extractUndefinedVariables(source);
-    expect(result).to.deep.equal(['name']);
-  });
-});

package/src/checks/metadata-params/index.spec.ts

@@ -1,257 +0,0 @@
-import { expect, describe, it } from 'vitest';
-import { MetadataParamsCheck } from '.';
-import { check } from '../../test';
-
-describe('Module: MetadataParamsCheck', () => {
-  it('should use doc tag as complete param list when present', async () => {
-    const file = `
-      {% doc %}
-        @param {Number} variable - param with description
-        @param {Number} variable2 - param with description
-      {% enddoc %}
-
-      {% assign a = 5 | plus: variable | plus: variable2 %}
-      {{ a }}
-    `;
-    const file2 = `
-      {% function a = 'commands/call/fileToCall', variable: 2, variable2: 12 %}
-      {{ a }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should report missing required doc params', async () => {
-    const file = `
-      {% doc %}
-        @param {Number} variable - param with description
-        @param {Number} variable2 - param with description
-      {% enddoc %}
-
-      {% assign a = 5 | plus: variable | plus: variable2 %}
-      {{ a }}
-    `;
-    const file2 = `
-      {% function a = 'commands/call/fileToCall', variable: 2 %}
-      {{ a }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(1);
-    expect(offenses).to.containOffense(
-      'Required parameter variable2 must be passed to function call',
-    );
-  });
-
-  it('should report unknown params not in doc', async () => {
-    const file = `
-      {% doc %}
-        @param {Number} variable - param with description
-      {% enddoc %}
-
-      {% assign a = 5 | plus: variable %}
-      {{ a }}
-    `;
-    const file2 = `
-      {% function a = 'commands/call/fileToCall', variable: 2, extra: 12 %}
-      {{ a }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(1);
-    expect(offenses).to.containOffense('Unknown parameter extra passed to function call');
-  });
-
-  it('should allow doc-optional params without requiring them', async () => {
-    const file = `
-      {% doc %}
-        @param {String} a - required
-        @param {String} [b] - optional
-      {% enddoc %}
-      {{ a }}{{ b }}
-    `;
-    const file2 = `
-      {% function res = 'commands/call/fileToCall', a: 'hello' %}
-      {{ res }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should allow passing doc-optional params without reporting unknown', async () => {
-    const file = `
-      {% doc %}
-        @param {String} a - required
-        @param {String} [b] - optional
-      {% enddoc %}
-      {{ a }}{{ b }}
-    `;
-    const file2 = `
-      {% function res = 'commands/call/fileToCall', a: 'hello', b: 'world' %}
-      {{ res }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should not require doc params that are not used in source', async () => {
-    const file = `
-      {% doc %}
-        @param {String} a - required param
-        @param {String} unused - required but not used in source
-      {% enddoc %}
-      {{ a }}
-    `;
-    const file2 = `
-      {% function res = 'commands/call/fileToCall', a: 'hello' %}
-      {{ res }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should infer required params from undefined variables when no doc', async () => {
-    const file = `
-      {% assign b = a %}
-      {{ b }}
-    `;
-    const file2 = `
-      {% function res = 'commands/call/fileToCall', a: 'hello' %}
-      {{ res }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should report missing inferred params when no doc', async () => {
-    const file = `
-      {% assign b = a %}
-      {{ b }}
-    `;
-    const file2 = `
-      {% function res = 'commands/call/fileToCall' %}
-      {{ res }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(1);
-    expect(offenses).to.containOffense('Required parameter a must be passed to function call');
-  });
-
-  it('should report unknown params when passing args not in inferred set', async () => {
-    const file = `
-      {% assign b = a %}
-      {{ b }}
-    `;
-    const file2 = `
-      {% function res = 'commands/call/fileToCall', a: 'hello', extra: 'world' %}
-      {{ res }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(1);
-    expect(offenses).to.containOffense('Unknown parameter extra passed to function call');
-  });
-
-  it('should not include global objects like context in inferred params', async () => {
-    const file = `
-      {{ context.session }}
-      {{ a }}
-    `;
-    const file2 = `
-      {% function res = 'commands/call/fileToCall', a: 'hello' %}
-      {{ res }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(0);
-  });
-
-  it('should work with render tags too', async () => {
-    const file = `{{ a }}`;
-    const file2 = `{% render 'fileToRender' %}`;
-    const files = {
-      'app/views/partials/fileToRender.liquid': file,
-      'app/views/pages/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(1);
-    expect(offenses).to.containOffense('Required parameter a must be passed to render call');
-  });
-
-  it('should skip validation when no doc and no undefined vars', async () => {
-    const file = `
-      {% assign a = 5 %}
-      {{ a }}
-    `;
-    const file2 = `
-      {% function res = 'commands/call/fileToCall', extra: 'hello' %}
-      {{ res }}
-    `;
-    const files = {
-      'app/lib/commands/call/fileToCall.liquid': file,
-      'app/lib/caller.liquid': file2,
-    };
-
-    const offenses = await check(files, [MetadataParamsCheck]);
-
-    expect(offenses).to.have.length(0);
-  });
-});