{"id":22165641,"url":"https://github.com/textileio/base","last_synced_at":"2026-02-22T04:35:18.003Z","repository":{"id":97399818,"uuid":"188526270","full_name":"textileio/base","owner":"textileio","description":"Base files we use to configure our repositories","archived":false,"fork":false,"pushed_at":"2019-06-20T13:36:50.000Z","size":46,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-26T14:12:21.006Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/textileio.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-25T05:50:36.000Z","updated_at":"2019-07-09T18:02:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"f79a67e9-0c5d-42d2-9ffd-cdae1fffd710","html_url":"https://github.com/textileio/base","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/textileio/base","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fbase","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fbase/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fbase/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fbase/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textileio","download_url":"https://codeload.github.com/textileio/base/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fbase/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29704823,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-22T03:17:42.375Z","status":"ssl_error","status_checked_at":"2026-02-22T03:17:31.622Z","response_time":110,"last_error":"SSL_read: 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":[],"created_at":"2024-12-02T05:15:51.162Z","updated_at":"2026-02-22T04:35:17.972Z","avatar_url":"https://github.com/textileio.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# base\nBase files we use to configure our repositories\n\n## Install\n\n### Install the appropriate editor plugins\n\n#### VSCode\n\n- Formatting / Linting\n    - https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig\n    - https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint\n    - https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode\n    - https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint\n    - https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck\n    - https://marketplace.visualstudio.com/items?itemName=shinnn.stylelint\n- Sharing\n    - https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare-pack\n- Languages\n    - https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go\n    - https://marketplace.visualstudio.com/items?itemName=vsmobile.vscode-react-native\n\nCustomise your eslint configuration with the following from @balupton's [configuration file](https://github.com/balupton/dotfiles/blob/master/.scripts/users/balupton/vscode/settings.json)\n\n``` json\n{\n\t\"editor.detectIndentation\": false,\n\t\"editor.formatOnSave\": true,\n\t\"editor.insertSpaces\": false,\n\t\"editor.renderControlCharacters\": true,\n\t\"editor.renderIndentGuides\": true,\n\t\"eslint.alwaysShowStatus\": true,\n\t\"eslint.autoFixOnSave\": true,\n\t\"eslint.enable\": true,\n\t\"eslint.run\": \"onType\",\n\t\"files.trimTrailingWhitespace\": true,\n\t\"html.format.enable\": true,\n\t\"json.format.enable\": true,\n\t\"prettier.semi\": false,\n\t\"prettier.singleQuote\": true,\n\t\"prettier.useTabs\": true,\n\t\"typescript.format.enable\": true,\n\t\"typescript.suggest.completeFunctionCalls\": true,\n\t\"typescript.tsdk\": \"./node_modules/typescript/lib\",\n\t\"typescript.updateImportsOnFileMove.enabled\": \"always\",\n\t\"typescript.validate.enable\": true,\n\t\"markdownlint.config\": {\n\t\t\"MD007\": {\n\t\t\t\"indent\": 4\n\t\t},\n\t\t\"MD012\": false,\n\t\t\"MD022\": false,\n\t\t\"MD030\": false,\n\t\t\"MD032\": false,\n\t\t\"MD034\": false\n\t},\n\t\"eslint.validate\": [\n\t\t\"javascript\",\n\t\t\"javascriptreact\",\n\t\t\"typescript\",\n\t\t\"typescriptreact\"\n\t],\n\t\"eslint.options\": {\n\t\t\"ignorePattern\": \"**/*.d.ts\"\n\t},\n\t\"[json]\": {\n\t\t\"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n\t},\n}\n```\n\n#### GoLand\n\n- Formatting / Linting\n    - https://plugins.jetbrains.com/plugin/10456-prettier\n    - https://www.jetbrains.com/help/go/configuring-code-style.html#editorconfig\n\n### Download\n\nUse [HTTPie](https://httpie.org/) via the Terminal to download the appropraite base files:\n\n``` shell\n# for all projects\nhttp -d https://raw.githubusercontent.com/textileio/base/master/.editorconfig\nhttp -d https://raw.githubusercontent.com/textileio/base/master/.gitignore\n\n# for web projects (projects that are mostly html/javascript/typescript)\nhttp -d https://raw.githubusercontent.com/textileio/base/master/.eslintignore\nhttp -d https://raw.githubusercontent.com/textileio/base/master/.prettierignore\n```\n\n### Setup\n\nIf convenient, make sure all PRs are merged beforehand to avoid merge conflicts.\n\n#### On Go/Java Projects\n\nOn go projects we want to run prettier on everything, but ignore the errors.\n\n``` bash\nnpx prettier --write \"./**\" 2\u003e /dev/null || true\n```\n\n#### On Web Projects\n\nUninstall the old dependencies:\n\n``` bash\nrm tslint.json\nnpm uninstall tslint tslint-react\n```\n\nInstall the dependencies:\n\n``` bash\n# javascript/typescript/react projects\nnpm i -D prettier eslint eslint-config-bevry eslint-config-prettier eslint-plugin-prettier\n    \n# typescript projects\nnpm i -D @typescript-eslint/eslint-plugin @typescript-eslint/parser\n\n# react projects\nnpm i -D eslint-plugin-react eslint-plugin-react-hooks @types/react\n```\n\nAdd the eslint/prettier script to say `package.json:scripts` as `build` or `lint` or whatever.\n\n``` bash\neslint --fix --ext .mjs,.js,.jsx,.ts,.tsx .\n```\n\nAdd the following to `package.json` which enables our rules:\n\n``` json\n{\n  \"eslintConfig\": {\n    \"extends\": [\n      \"bevry\"\n    ],\n    \"parserOptions\": {\n      \"ecmaVersion\": 6,\n      \"sourceType\": \"module\",\n      \"ecmaFeatures\": {\n        \"jsx\": true\n      }\n    }\n  },\n  \"prettier\": {\n    \"semi\": false,\n    \"singleQuote\": true\n  }\n}\n```\n\nFor typescript projects, you may wish to add the following to make the rules more compatible with typescript conventions:\n\n``` json\n{\n  \"eslintConfig\": {\n    \"rules\": {\n      \"no-undefined\": 0,\n      \"default-case\": 0\n    }\n  }\n}\n```\n\n## About\n\nRefer to these discussion threads:\n\n- [Add an `.editorconfig` to each repository #3\n](https://github.com/textileio/meta/issues/3)\n- [Adopt prettier on all repositories #4](https://github.com/textileio/meta/issues/4)\n- [Convert TSLint to ESLint #35](https://github.com/textileio/meta/issues/35)\n- [Adopt shellcheck for linting all bash/shell scripts #5](https://github.com/textileio/meta/issues/5)\n- [Adopt awesome-travis/surge to deploy repositories to static hosting #6](https://github.com/textileio/meta/issues/6)\n\nInspired by [bevry/base](https://github.com/bevry/base)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextileio%2Fbase","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextileio%2Fbase","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextileio%2Fbase/lists"}