{"id":43507616,"url":"https://github.com/zextras/carbonio-ui-configs","last_synced_at":"2026-02-03T12:39:32.612Z","repository":{"id":45063245,"uuid":"446850129","full_name":"zextras/carbonio-ui-configs","owner":"zextras","description":"Configurations set used by Zextras Carbonio UI projects","archived":false,"fork":false,"pushed_at":"2025-10-30T15:22:21.000Z","size":726,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":14,"default_branch":"devel","last_synced_at":"2025-10-30T17:28:12.723Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zextras.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-01-11T14:17:04.000Z","updated_at":"2025-10-30T15:22:15.000Z","dependencies_parsed_at":"2023-02-17T07:31:23.731Z","dependency_job_id":"4f3e3f64-ee27-4372-96fc-dfa9fbd9dc00","html_url":"https://github.com/zextras/carbonio-ui-configs","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"purl":"pkg:github/zextras/carbonio-ui-configs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-ui-configs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-ui-configs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-ui-configs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-ui-configs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zextras","download_url":"https://codeload.github.com/zextras/carbonio-ui-configs/tar.gz/refs/heads/devel","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zextras%2Fcarbonio-ui-configs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29046179,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T10:09:22.136Z","status":"ssl_error","status_checked_at":"2026-02-03T10:09:16.814Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":[],"created_at":"2026-02-03T12:39:31.147Z","updated_at":"2026-02-03T12:39:32.602Z","avatar_url":"https://github.com/zextras.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nSPDX-FileCopyrightText: 2023 Zextras \u003chttps://www.zextras.com\u003e\n\nSPDX-License-Identifier: AGPL-3.0-only\n--\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003eCarbonio UI Configs \u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\nThis is the configurations set used by Zextras Carbonio ui projects\n\n[![Contributors][contributors-badge]][contributors]\n[![Activity][activity-badge]][activity]\n[![License][license-badge]](COPYING)\n[![Project][project-badge]][project]\n[![Twitter][twitter-badge]][twitter]\n\n\u003c/div\u003e\n\n## Installation\n\n```\nnpm install --save-dev @zextras/carbonio-ui-configs\n```\n\n## Setup\n\nTo use the configuration set, you need to configure eslint, prettier and typescript to\nextend the rules defined in this package.\n\n### Eslint\n\nThe eslint configuration to extends is included in `rules/eslint.js`, extends your configuration\nfile as the following\n\n```js\n// .eslintrc.js\n\nmodule.exports = {\n  extends: ['./node_modules/@zextras/carbonio-ui-configs/rules/eslint.js']\n};\n```\nIn order to make eslint recognize the plugins configured within this package, an additional\nparameter is required when running eslint command: `--resolve-plugins-relative-to node_modules/@zextras/carbonio-ui-configs`\n\nYou can configure a script inside the package.json and then run `npm run lint` to easily run eslint with the required configuration:\n```json5 lines\n// package.json\n{\n    \"scripts\": {\n        \"lint\": \"eslint --ext .js,.jsx,.ts,.tsx --resolve-plugins-relative-to node_modules/@zextras/carbonio-ui-configs src\"\n        // other scripts\n    }\n}\n```\n\n### Prettier\nPrettier needs to be configured to extend the rules defined in `rules/prettier.js`\n\n```js\n// .prettierrc.js\nmodule.exports = {\n  ...require('@zextras/carbonio-ui-configs/rules/prettier')\n}\n```\n\n### Typescript\nThere are two typescript configuration available, one for type-checking Carbonio modules projects, the other for creating\nthe types for the integrations exported by the module, so that the types can be used by other projects to type the used\nintegrations.\n\nThe configuration for the type-check is the rules/tsconfig.type-check.json and should be used as extension in the\nmain tsconfig.json of the projects.\n\n```json5 lines\n// tsconfig.json\n{\n  \"extends\": \"@zextras/carbonio-ui-configs/rules/tsconfig.type-check.json\"\n}\n```\n```json5 lines\n// package.json\n{\n  \"scripts\": {\n    // ... other scripts ...\n    \"type-check\": \"tsc\"\n  }\n}\n```\n\nThe second one, to generate a package type, is the rules/tsconfig.lib.json and should be used as an extension in a\nspecific tsconfig (e.g. tsconfig.lib.json), which is then used in a build:lib script of the package.json\n\n```json5 lines\n// tsconfig.lib.json\n{\n  \"extends\": \"@zextras/carbonio-ui-configs/rules/tsconfig.lib.json\",\n  \"compilerOptions\": {\n    \"types\": [\"node\", /* add here additional types declarations, like styled-components.d.ts and i18next.d.ts */],\n    \"outDir\": \"lib\"\n  },\n  \"files\": [\n    // the entry point(s) for the integration exports, e.g. src/lib.ts\n  ]\n}\n```\n```json5 lines\n// package.json\n{\n  \"name\": \"@zextras/carbonio-\u003cmodule\u003e-ui\",\n  \"files\": [\"lib\", \"THIRDPARTIES\"],\n  \"exports\": {\n    \".\": {\n      \"types\": \"lib/\u003centry point\u003e.d.ts\" // e.g. lib/lib.d.ts if the entry point is src/lib.ts\n    },\n    \"./*\": null\n  },\n  \"scripts\": {\n    // ... other scripts ...\n    \"build:lib\": \"rm -rf lib \u0026\u0026 tsc -P tsconfig.lib.json\",\n    \"prepare\": \"(is-ci || husky); npm run build:lib\"\n  }\n}\n```\n\nRemember to exclude the lib folder from git by adding an entry to the .gitignore\n```\n// .gitignore\n\n// ... other entries ...\n/lib\n```\n\n## License\nCarbonio UI Configs - Configurations set for Zextras Carbonio UI projects\n\nCopyright (C) 2022 Zextras \u003chttps://www.zextras.com\u003e\n\nThis program is free software: you can redistribute it and/or modify it\nunder the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, version 3 only of the License.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT\nANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\nFITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License\nfor more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see [Licenses - GNU Project - Free\nSoftware Foundation](https://www.gnu.org/licenses/licenses.html\n\"https://www.gnu.org/licenses/licenses.html\")\n\nSee [COPYING](COPYING) file for the project license details\n\nSee [THIRDPARTIES](THIRDPARTIES) file for other licenses details\n\n### Copyright notice\n\nAll non-software material (such as, for example, names, images, logos, sounds) is owned by Zextras s.r.l. and is licensed under [CC-BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/).\n\nWhere not specified, all source files owned by Zextras s.r.l. are licensed under AGPL-3.0-only\n\n[contributors-badge]: https://img.shields.io/github/contributors/zextras/carbonio-ui-configs \"Contributors\"\n[contributors]: https://github.com/zextras/carbonio-ui-configs/graphs/contributors \"Contributors\"\n[activity-badge]: https://img.shields.io/github/commit-activity/m/zextras/carbonio-ui-configs \"Activity\"\n[activity]: https://github.com/zextras/carbonio-ui-configs/pulse \"Activity\"\n[license-badge]: https://img.shields.io/badge/license-AGPL%203-green \"License AGPL 3\"\n[project-badge]: https://img.shields.io/badge/project-carbonio-informational \"Project Carbonio\"\n[project]: https://www.zextras.com/carbonio/ \"Project Carbonio\"\n[twitter-badge]: https://img.shields.io/twitter/follow/zextras?style=social\u0026logo=twitter \"Follow on Twitter\"\n[twitter]: https://twitter.com/intent/follow?screen_name=zextras \"Follow Zextras on Twitter\"\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzextras%2Fcarbonio-ui-configs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzextras%2Fcarbonio-ui-configs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzextras%2Fcarbonio-ui-configs/lists"}