Skip to content

Latest commit

 

History

History

filter-files

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
rules
rules
 
 
README.md
README.md
 
 
README_yodoc.md
README_yodoc.md
 
 
hello-2.csv
hello-2.csv
 
 
hello.csv
hello.csv
 
 
hello.toml
hello.toml
 
 
lintnet.jsonnet
lintnet.jsonnet
 
 

README.md

Filter files

First, please run lintnet lint.

lintnet lint
{
  "lintnet_version": "0.4.7",
  "env": "darwin/arm64",
  "errors": [
    {
      "name": "age must be greater or equal than 18",
      "lint_file": "rules/csv/main.jsonnet",
      "data_file": "hello-2.csv",
      "target_id": "csv",
      "location": {
        "index": 0,
        "line": "jo,5"
      }
    },
    {
      "name": "age must be greater or equal than 18",
      "lint_file": "rules/csv/main.jsonnet",
      "data_file": "hello.csv",
      "target_id": "csv",
      "location": {
        "index": 0,
        "line": "mike,10"
      }
    },
    {
      "name": "age must be greater or equal than 18",
      "lint_file": "rules/csv/main.jsonnet",
      "data_file": "hello.csv",
      "target_id": "csv",
      "location": {
        "index": 1,
        "line": "alex,15"
      }
    },
    {
      "name": "TOML requires the field \"name\"",
      "lint_file": "rules/toml/main.jsonnet",
      "data_file": "hello.toml",
      "target_id": "toml"
    }
  ]
}

Lint only given files

You can lint only give files.

lintnet lint hello.toml
{
  "lintnet_version": "0.4.7",
  "env": "darwin/arm64",
  "errors": [
    {
      "name": "TOML requires the field \"name\"",
      "lint_file": "rules/toml/main.jsonnet",
      "data_file": "hello.toml"
    }
  ]
}

Specify a target

You can lint only a given target.

lintnet lint -target csv
{
  "lintnet_version": "0.4.7",
  "env": "darwin/arm64",
  "errors": [
    {
      "name": "age must be greater or equal than 18",
      "lint_file": "rules/csv/main.jsonnet",
      "data_file": "hello-2.csv",
      "target_id": "csv",
      "location": {
        "index": 0,
        "line": "jo,5"
      }
    },
    {
      "name": "age must be greater or equal than 18",
      "lint_file": "rules/csv/main.jsonnet",
      "data_file": "hello.csv",
      "target_id": "csv",
      "location": {
        "index": 0,
        "line": "mike,10"
      }
    },
    {
      "name": "age must be greater or equal than 18",
      "lint_file": "rules/csv/main.jsonnet",
      "data_file": "hello.csv",
      "target_id": "csv",
      "location": {
        "index": 1,
        "line": "alex,15"
      }
    }
  ]
}

You can also combine file paths and target id.

lintnet lint -target csv hello.csv
{
  "lintnet_version": "0.4.7",
  "env": "darwin/arm64",
  "errors": [
    {
      "name": "age must be greater or equal than 18",
      "lint_file": "rules/csv/main.jsonnet",
      "data_file": "/Users/shunsukesuzuki/repos/src/github.com/lintnet/examples/filter-files/hello.csv",
      "target_id": "csv",
      "location": {
        "index": 0,
        "line": "mike,10"
      }
    },
    {
      "name": "age must be greater or equal than 18",
      "lint_file": "rules/csv/main.jsonnet",
      "data_file": "/Users/shunsukesuzuki/repos/src/github.com/lintnet/examples/filter-files/hello.csv",
      "target_id": "csv",
      "location": {
        "index": 1,
        "line": "alex,15"
      }
    }
  ]
}

Test only specific files

If you run lintnet test without any argument, lintnet searches lint files with a configuration file and tests all lint files with test files. But you can also test only specific files by specifying files as arguments. If you specify files explicitly, a configuration file is unnecessary. This means when you develop modules, you don't have to prepare a configuration file.

lintnet test
Result 
Test Name: pass
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/pass.csv: no such file or directory
==========
Test Name: fail
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/fail.csv: no such file or directory
==========
Test Name: pass
Lint file: rules/toml/main.jsonnet
Test file: rules/toml/main_test.jsonnet
Error: read a data file: read a file: open rules/toml/testdata/pass.toml: no such file or directory
==========
Test Name: fail
Lint file: rules/toml/main.jsonnet
Test file: rules/toml/main_test.jsonnet
Error: read a data file: read a file: open rules/toml/testdata/fail.toml: no such file or directory
==========

time=2024-06-16T15:17:40+09:00 level=fatal msg=lintnet failed env=darwin/arm64 error=test failed program=lintnet version=0.4.7


lintnet test rules/csv/main.jsonnet
Result 
Test Name: pass
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/pass.csv: no such file or directory
==========
Test Name: fail
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/fail.csv: no such file or directory
==========

time=2024-06-16T15:17:40+09:00 level=fatal msg=lintnet failed env=darwin/arm64 error=test failed program=lintnet version=0.4.7


lintnet test rules/csv/main_test.jsonnet
Result 
Test Name: pass
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/pass.csv: no such file or directory
==========
Test Name: fail
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/fail.csv: no such file or directory
==========

time=2024-06-16T15:17:40+09:00 level=fatal msg=lintnet failed env=darwin/arm64 error=test failed program=lintnet version=0.4.7

If you specify directories, lint files in those directories are tested.

lintnet test rules/csv
Result 
Test Name: pass
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/pass.csv: no such file or directory
==========
Test Name: fail
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/fail.csv: no such file or directory
==========

time=2024-06-16T15:17:40+09:00 level=fatal msg=lintnet failed env=darwin/arm64 error=test failed program=lintnet version=0.4.7


lintnet test rules
Result 
Test Name: pass
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/pass.csv: no such file or directory
==========
Test Name: fail
Lint file: rules/csv/main.jsonnet
Test file: rules/csv/main_test.jsonnet
Error: read a data file: read a file: open rules/csv/testdata/fail.csv: no such file or directory
==========
Test Name: pass
Lint file: rules/toml/main.jsonnet
Test file: rules/toml/main_test.jsonnet
Error: read a data file: read a file: open rules/toml/testdata/pass.toml: no such file or directory
==========
Test Name: fail
Lint file: rules/toml/main.jsonnet
Test file: rules/toml/main_test.jsonnet
Error: read a data file: read a file: open rules/toml/testdata/fail.toml: no such file or directory
==========

time=2024-06-16T15:17:40+09:00 level=fatal msg=lintnet failed env=darwin/arm64 error=test failed program=lintnet version=0.4.7