{"id":32623151,"url":"https://github.com/jotsr/freecad_name_conv_checker","last_synced_at":"2026-04-12T08:41:16.651Z","repository":{"id":228600281,"uuid":"774427649","full_name":"JOTSR/freecad_name_conv_checker","owner":"JOTSR","description":"The simple and flexible FreeCAD name convention checker","archived":false,"fork":false,"pushed_at":"2024-03-26T09:29:21.000Z","size":259492,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-30T19:55:43.697Z","etag":null,"topics":["api","cli","conventions","deno","freecad","jsr","typescript","utils"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JOTSR.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-19T14:32:14.000Z","updated_at":"2024-03-21T08:47:43.000Z","dependencies_parsed_at":"2024-03-26T10:48:59.502Z","dependency_job_id":null,"html_url":"https://github.com/JOTSR/freecad_name_conv_checker","commit_stats":null,"previous_names":["jotsr/freecad_name_conv_checker"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/JOTSR/freecad_name_conv_checker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JOTSR%2Ffreecad_name_conv_checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JOTSR%2Ffreecad_name_conv_checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JOTSR%2Ffreecad_name_conv_checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JOTSR%2Ffreecad_name_conv_checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JOTSR","download_url":"https://codeload.github.com/JOTSR/freecad_name_conv_checker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JOTSR%2Ffreecad_name_conv_checker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31709294,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-12T06:22:27.080Z","status":"ssl_error","status_checked_at":"2026-04-12T06:21:52.710Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","cli","conventions","deno","freecad","jsr","typescript","utils"],"created_at":"2025-10-30T19:54:27.894Z","updated_at":"2026-04-12T08:41:16.643Z","avatar_url":"https://github.com/JOTSR.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\t\t\u003cimg src=\"./assets/logo.png\" alt=\"logo\" width=\"150px\" height=\"150px\"/\u003e\n\t\t\u003ch1\u003e📋FCNC✔️\u003c/h1\u003e\n\t\t\u003cp\u003eThe simple and flexible FreeCAD name convention checker\u003c/p\u003e\n\u003c/div\u003e\n\n[![JSR](https://jsr.io/badges/@jotsr/fcnc?style=flat-square)](https://jsr.io/@jotsr/fcnc)\n[![JSR](https://jsr.io/badges/@jotsr/fcnc/score?style=flat-square)](https://jsr.io/@jotsr/fcnc)\n![GitHub License](https://img.shields.io/github/license/JOTSR/freecad_name_conv_checker?style=flat-square)\n![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/JOTSR/freecad_name_conv_checker/total?style=flat-square)\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/JOTSR/freecad_name_conv_checker/publish.yml?style=flat-square)\n\n`fcnc` tool allows you to check your custom name convention of your\n[FreeCAD](https://www.freecad.org/) models (based on\n[fcinfo](https://github.com/FreeCAD/FreeCAD/blob/main/src/Tools/fcinfo) output).\n\n## Basic usage\n\n### Requirements\n\n- [fcinfo](https://github.com/FreeCAD/FreeCAD/blob/main/src/Tools/fcinfo) for\n  extracting informations from `FreeCAD` files.\n- [python3](https://www.python.org/downloads/) for running `fcinfo`.\n- [deno](https://deno.land) only for contributing or for installation-less use.\n\n### CLI\n\n- Get help:\n  ```sh\n  fcnc --help\n  ```\n\n- Get command help:\n  ```sh\n  fcnc \u003ccommand\u003e --help\n  ```\n\n- Check constraints:\n  ```sh\n  # Run fcinfo\n  ./fcinfo my_freecad_model.FCStd \u003e any_file.fcinfo\n\n  # Check name convention\n  fcnc check my_constraints.ts any_file.fcinfo or*globs?.fcinfo\n  ```\n\n### API\n\nAvailable on [jsr:@jotsr/fcnc](https://jsr.io/@jotsr/fcnc).\n\n```ts\nimport { type Constraint } from 'jsr:@jotsr/fcnc'\n\nconst snakeCaseLabel = /[a-z][a-z0-9_]*[a-z0-9]/\n\nconst fileLabel: Constraint = {\n\t//Type of constraint\n\tkind: 'file:label',\n\t//Pattern to match ($fields refers to custom regexp)\n\tpattern: '$label.$type',\n\t//All \"$\" fields need to be defined\n\tfields: {\n\t\t//Array of regexp to match against (order matter)\n\t\tlabel: [snakeCaseLabel],\n\t\ttype: [/part/, /assembly/],\n\t},\n}\n\n//name convention file should export array of constraints as default export\nexport default [fileLabel]\n```\n\n### [Documentation](#doc)\n\n## Installation\n\n### From [deno](https://deno.land)\n\nWithout install\n\n```sh\ndeno run --allow-read=your-dir jsr:@jotsr/fcnc\n```\n\nWith install\n\n```sh\ndeno install --allow-read --allow-net=api.github.com -rf jsr:@jotsr/fcnc\n```\n\n[Deno permissions](https://docs.deno.com/runtime/manual/basics/permissions)\nexplanations\n\n- `--allow-read` to read input files.\n- `--allow-net=api.github.com` to upgrade the cli.\n\n### From binaries\n\n```sh\n# Linux\ncurl -fsSLo fcnc https://github.com/JOTSR/release/download/$VERSION/fcnc-x86_64-unknown-linux-gnu.gz\ncurl -fsSLo fcnc https://github.com/JOTSR/release/download/$VERSION/fcnc-aarch64-unknown-linux-gnu.gz\n\n# macOS\ncurl -fsSLo fcnc https://github.com/JOTSR/release/download/$VERSION/fcnc-x86_64-apple-darwin.gz\ncurl -fsSLo fcnc https://github.com/JOTSR/release/download/$VERSION/fcnc-aarch64-apple-darwin.gz\n\n# Windows\ncurl -fsSLo fcnc.exe https://github.com/JOTSR/release/download/$VERSION/fcnc-x86_64-pc-windows-msvc.exe.gz\n```\n\n## Doc\n\n### CLI\n\n- `fcnc --help`.\n- Some [examples](./examples).\n\n### API\n\nAvailable on [jsr:@jotsr/fcnc](https://jsr.io/@jotsr/fcnc/doc).\n\n## Contributing\n\nAny kind of contribution is welcomed. Please read\n[contributing guidelines](./CONTRIBUTING.md) before and respect\n[contributor covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).\n\n### For local development:\n\n**Required dependencies**:\n\n- [`deno`](https://deno.land) To run project (code, ci, ...).\n\n**Before first commit or after editing [`./deno.json`](./deno.json)**:\n\n- Run `deno task hooks:install`.\n\n**Using VSCode**:\n\n- Pre-configured workspace available in\n  [`fcnc.code-workspace`](./fcnc.code-workspace).\n- Or without local tooling install use [`.devcontainer`](./.devcontainer).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjotsr%2Ffreecad_name_conv_checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjotsr%2Ffreecad_name_conv_checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjotsr%2Ffreecad_name_conv_checker/lists"}