{"id":15697668,"url":"https://github.com/kt3k/souffle","last_synced_at":"2025-03-30T14:11:48.343Z","repository":{"id":57366404,"uuid":"46692756","full_name":"kt3k/souffle","owner":"kt3k","description":"DEPRECATED","archived":false,"fork":false,"pushed_at":"2017-01-17T14:27:21.000Z","size":13,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-06T04:14:23.113Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://npm.im/souffle-cli","language":"JavaScript","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/kt3k.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-23T02:48:43.000Z","updated_at":"2017-01-19T14:56:35.000Z","dependencies_parsed_at":"2022-08-23T20:10:37.820Z","dependency_job_id":null,"html_url":"https://github.com/kt3k/souffle","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kt3k%2Fsouffle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kt3k%2Fsouffle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kt3k%2Fsouffle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kt3k%2Fsouffle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kt3k","download_url":"https://codeload.github.com/kt3k/souffle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246326795,"owners_count":20759439,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-10-03T19:20:58.409Z","updated_at":"2025-03-30T14:11:48.328Z","avatar_url":"https://github.com/kt3k.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JavaScript Soufflé Style v3.1.1 [![js-souffle-style](https://img.shields.io/badge/code%20style-soufflé-brightgreen.svg)](https://github.com/kt3k/souffle)\n\n\u003e A style checker. based on eslint, similar to [standard](https://github.com/feross/standard), allows more spaces.\n\n# Install\n\n```\nnpm install --save souffle-cli\n```\n\nThe above installs `souffle` command.\n\n# Rules\n\n- **4 spaces** for indent (configurable)\n- **no semicolons** (configurable)\n- **allow padded block**\n- Check [feross/standard](https://github.com/feross/standard) for the rest of the rules.\n\n***Any rule can be modified by the option settings in package.json***\n\nYou can create a similar command with your .eslintrc using [white-lint](https://github.com/kt3k/white-lint) module.\n\n# Usage\n\n## Package options\n\nThe behaviour of the command can be modified by the object at `souffle` key of the package.json.\n\nSee the examples below for details.\n\n### `globals`: Array\u003cString\u003e\n\nSet globals variables.\n\n```json\n{\n    \"name\": \"your-package\",\n    \"souffle\": {\n        \"globals\": [\"$\", \"util\"]\n    }\n}\n```\n\nThe above sets `$` and `util` as global variables.\n\n\n### `parser`: String\n\nSet the custom parser.\n\n```json\n{\n    \"name\": \"your-package\",\n    \"souffle\": {\n        \"parser\": \"babel-eslint\"\n    }\n}\n```\n\nThe above use babel-eslint as the parser.\n\n### `rules`: Object\n\nSet or overwrite any rules of eslint.\n\n```json\n{\n    \"name\": \"your-package\",\n    \"souffle\": {\n        \"rules\": {\n            \"operator-linebreak\": 0\n        }\n    }\n}\n```\n\nThe above turns `operator-linebreak` rule off.\n\n### `indent`: Number|'tab'\n\nSet space indent size or tab indent. (default: 4)\n\n```json\n{\n    \"name\": \"your-package\",\n    \"souffle\": {\n        \"indent\": \"tab\"\n    }\n}\n```\n\nThe above sets tab indent.\n\n```json\n{\n    \"name\": \"your-package\",\n    \"souffle\": {\n        \"indent\": 2\n    }\n}\n```\n\nThe above sets 2 space indent.\n\n### `semi`: Boolean\n\nSet `true` if you use semicolon at the end of each line.\n\n```json\n{\n    \"name\": \"your-package\",\n    \"souffle\": {\n        \"semi\": true\n    }\n}\n```\n\nThe above sets to use semicolons.\n\n## Command line options\n\nOptionally the command behaviour can be modified by the command line options.\n\n```\nUsage:\n    souffle \u003cflags\u003e [FILES...]\n\n    If FILES is omitted, then all JavaScript source files (*.js, *.jsx) in the current\n    working directory are checked, recursively.\n\n    Certain paths (node_modules/, .git/, coverage/, *.min.js, bundle.js) are\n    automatically ignored.\n\nFlags:\n        --global    Declare global variable (can be set multiple times)\n        --parser    Use custom js parser (e.g. babel-eslint)\n    -2, --2         Use 2 space indent\n    -4, --4         Use 4 space indent\n        --tab       Use tab indent\n        --semi      Use semicolon\n        --no-semi   Don't use semicolon\n    -h, --help      Show usage information\n    -v, --version   Show current version\n```\n\n# Badge\n\n[![js-soufflé-style](https://img.shields.io/badge/code%20style-soufflé-brightgreen.svg)](https://github.com/kt3k/souffle)\n\n```md\n[![js-soufflé-style](https://img.shields.io/badge/code%20style-soufflé-brightgreen.svg)](https://github.com/kt3k/souffle)\n```\n\n\n# License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkt3k%2Fsouffle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkt3k%2Fsouffle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkt3k%2Fsouffle/lists"}