{"id":35518980,"url":"https://github.com/winccoa-tools-pack/template-npm-shared-library","last_synced_at":"2026-03-09T00:04:14.068Z","repository":{"id":327216822,"uuid":"1105598103","full_name":"winccoa-tools-pack/template-npm-shared-library","owner":"winccoa-tools-pack","description":"The template for WinCC OA NPM packages","archived":false,"fork":false,"pushed_at":"2026-03-04T21:50:02.000Z","size":461,"stargazers_count":1,"open_issues_count":7,"forks_count":0,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2026-03-05T02:51:43.560Z","etag":null,"topics":["automation","etm","hmi","industrial-automation","npm","scada","siemens","vscode","wincc-oa","winccoa"],"latest_commit_sha":null,"homepage":"https://github.com/winccoa-tools-pack","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/winccoa-tools-pack.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","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},"funding":{"buy_me_a_coffee":"mPokornyETM"}},"created_at":"2025-11-27T21:38:24.000Z","updated_at":"2026-03-04T20:58:40.000Z","dependencies_parsed_at":"2026-03-03T23:05:10.281Z","dependency_job_id":null,"html_url":"https://github.com/winccoa-tools-pack/template-npm-shared-library","commit_stats":null,"previous_names":["winccoa-tools-pack/template-npm-shared-library"],"tags_count":6,"template":true,"template_full_name":null,"purl":"pkg:github/winccoa-tools-pack/template-npm-shared-library","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winccoa-tools-pack%2Ftemplate-npm-shared-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winccoa-tools-pack%2Ftemplate-npm-shared-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winccoa-tools-pack%2Ftemplate-npm-shared-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winccoa-tools-pack%2Ftemplate-npm-shared-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/winccoa-tools-pack","download_url":"https://codeload.github.com/winccoa-tools-pack/template-npm-shared-library/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winccoa-tools-pack%2Ftemplate-npm-shared-library/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30278153,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T20:45:49.896Z","status":"ssl_error","status_checked_at":"2026-03-08T20:45:49.525Z","response_time":56,"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":["automation","etm","hmi","industrial-automation","npm","scada","siemens","vscode","wincc-oa","winccoa"],"created_at":"2026-01-03T23:09:39.569Z","updated_at":"2026-03-09T00:04:14.047Z","avatar_url":"https://github.com/winccoa-tools-pack.png","language":"TypeScript","funding_links":["https://buymeacoffee.com/mPokornyETM"],"categories":[],"sub_categories":[],"readme":"---\nMinimal starter template for creating shared WinCC OA NPM libraries\nTHIS IS AN EXAMPLE README\n---\n\n\n# WinCC OA UI PNL/XML Converter\n\nA lightweight developer tool for SIMATIC WinCC Open Architecture projects, providing reliable PNL ⇄ XML transformations for UI panels.\nThis package is part of the modular winccoa-tools-pack ecosystem, which delivers modern development tooling,\nreusable libraries, and VS Code extensions for WinCC OA engineers.\n[github.com](https://github.com/winccoa-tools-pack)\n\n## ✨ Features\n\n- **PNL → XML conversion**  \n  Transform classic .pnl UI panel files into structured XML suitable for analysis, automation, and editor tooling.\n\n- **XML → PNL conversion**  \n  Regenerate WinCC OA .pnl files from XML to enable round-trip workflows and external processing.\n\n- **Tooling-friendly design**  \n  Built to integrate with next-generation WinCC OA development tools such as VS Code extensions,\n  reusable workflows, and advanced analysis pipelines,\n  consistent with the overall goals of the winccoa-tools-pack organization.\n\n- **Modern project template**  \n  Generated from the shared npm-winccoa-template to ensure consistent structure, CI/CD, TypeScript setup, linting, and maintainability across the ecosystem.\n\n## 📦 Installation\n\n```shell\nnpm install @winccoa-tools-pack/npm-winccoa-ui-pnl-xml\n```\n\nOr globally:\n\n```shell\nnpm install -g @winccoa-tools-pack/npm-winccoa-ui-pnl-xml\n```\n\n## 🖥 Usage (CLI)\n\n```shell\n# Convert .pnl → .xml (in-place)\nwinccoa-pnl-xml convert pnl-to-xml about.pnl --version 3.20\n\n# Convert .xml → .pnl (in-place)\nwinccoa-pnl-xml convert xml-to-pnl about.xml --version 3.20\n\n# Optional flags\n#   --config \u003cpath\u003e   Use a specific project config file\n#   --overwrite       Overwrite existing output files\n#   --timeout \u003cms\u003e    Increase process timeout\n```\n\n## ⚠️ Important behavior\n\n- Conversion is performed by WinCC OA `WCCOAui` and is **in-place** (the input file is rewritten).\n- WinCC OA may create a `.bak` file next to the input.\n- The input passed to `-p` is typically resolved relative to the project’s `panels/` directory.\n  Use `--config` if you need to point the converter at a specific project context.\n\n## 🧩 Usage (API)\n\n```typescript\nimport { pnlToXml, xmlToPnl } from \"@winccoa-tools-pack/npm-winccoa-ui-pnl-xml\";\n\n// Note: WinCC OA performs the conversion in-place and may create a .bak backup.\n// The input path is typically resolved relative to the project’s panels/ directory.\n\nconst pnlToXmlResult = await pnlToXml({\n  version: \"3.20\",\n  inputPath: \"about.pnl\",\n  // configPath: \"C:/path/to/project/config/config\",\n  // overwrite: true,\n  // timeout: 120_000,\n});\n\nif (!pnlToXmlResult.success) {\n  throw new Error(`Conversion failed (exit ${pnlToXmlResult.exitCode}): ${pnlToXmlResult.stderr}`);\n}\n\nconst xmlToPnlResult = await xmlToPnl({\n  version: \"3.20\",\n  inputPath: \"about.xml\",\n});\n\nconsole.log({ pnlToXmlResult, xmlToPnlResult });\n```\n\nMore details: see [docs/USAGE.md](docs/USAGE.md).\n\n## 🩺 Troubleshooting\n\n- Non-zero exit code: inspect `stderr` and ensure `--version` matches your WinCC OA installation.\n- Timeouts on large panels: increase `--timeout` / `timeout`.\n- File not found: remember `inputPath` is usually relative to `panels/` in the active project context.\n\n## 📚 Ecosystem Integration\n\nThis package is designed for seamless use with:\n\n- **VS Code extensions for WinCC OA development**  \n  Our open source community provides multiple VS Code tools that enhance the engineering workflow\n  for WinCC OA developers. This converter acts as a foundation for UI-related features such as the Panel Explorer.\n\n- **Node.js libraries**  \n  Works side-by-side with other libraries in the winccoa-tools-pack suite (project management, core utilities, testing, etc.).\n\n- **CI/CD automation**  \n  Ideal for pipelines needing validation or transformation of UI panel resources.\n\n- **Automation tokens** are recommended for CI/CD (they don't expire but can be revoked)\n- The token needs **publish** permission for your package scope\n- For scoped packages (`@winccoa-tools-pack/...`), ensure your NPM organization allows publishing\n\n### Testing Without NPM_TOKEN\n\nIf `NPM_TOKEN` is not configured, the workflow will:\n\n- ✅ Still run tests and build the package\n- ✅ Create GitHub releases with artifacts\n- ⚠️ Skip NPM publishing with a warning message\n\nYou can always publish manually later:\n\n```bash\nnpm publish --access public\n```\n\n## 📦 Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Build the library\nnpm run build\n\n# Run tests\nnpm test\n\n# Lint code\nnpm run lint\n```\n\n## 🏆 Recognition\n\nSpecial thanks to all our [contributors](https://github.com/orgs/winccoa-tools-pack/people) who make this project possible!\n\n### Key Contributors\n\n- **Martin Pokorny** ([@mPokornyETM](https://github.com/mPokornyETM)) - Creator \u0026 Lead Developer\n- And many more amazing contributors!\n\n---\n\n## 📜 License\n\nThis project is basically licensed under the **MIT License** - see the [LICENSE](https://github.com/winccoa-tools-pack/.github/blob/main/LICENSE) file for details.\n\nIt might happen that partial repositories contain third party SW which uses other license models.\n\n---\n\n## ⚠️ Disclaimer\n\n**WinCC OA** and **Siemens** are trademarks of Siemens AG.\nThis project is not affiliated with, endorsed by, or sponsored by Siemens AG.\nThis is a community-driven open source project created to enhance the development experience for WinCC OA developers.\n\n---\n\n## 🎉 Thank You\n\nThank you for using WinCC OA tools package! We're excited to be part of your development journey.\n\nHappy Coding! 🚀\n\n---\n\n## Quick Links\n\n[📦 VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=mPokornyETM.wincc-oa-projects)\n\nMade with ❤️ for and by the WinCC OA community\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinccoa-tools-pack%2Ftemplate-npm-shared-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwinccoa-tools-pack%2Ftemplate-npm-shared-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinccoa-tools-pack%2Ftemplate-npm-shared-library/lists"}