{"id":15638157,"url":"https://github.com/kennethanceyer/formulize","last_synced_at":"2025-08-20T14:31:25.190Z","repository":{"id":5967846,"uuid":"53918230","full_name":"KennethanCeyer/formulize","owner":"KennethanCeyer","description":":waning_crescent_moon: formula ui generator","archived":false,"fork":false,"pushed_at":"2021-11-09T15:22:08.000Z","size":7881,"stargazers_count":95,"open_issues_count":17,"forks_count":17,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-12-10T02:20:53.609Z","etag":null,"topics":["calculate","component","expression","formula","javascript","libary","parser","wysiwyg"],"latest_commit_sha":null,"homepage":"http://www.pigno.se/barn/PIGNOSE-Formula/","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/KennethanCeyer.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":"2016-03-15T05:45:55.000Z","updated_at":"2024-12-09T06:41:07.000Z","dependencies_parsed_at":"2022-08-02T20:46:05.864Z","dependency_job_id":null,"html_url":"https://github.com/KennethanCeyer/formulize","commit_stats":null,"previous_names":["kennethanceyer/formula"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KennethanCeyer%2Fformulize","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KennethanCeyer%2Fformulize/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KennethanCeyer%2Fformulize/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KennethanCeyer%2Fformulize/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KennethanCeyer","download_url":"https://codeload.github.com/KennethanCeyer/formulize/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230431103,"owners_count":18224655,"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":["calculate","component","expression","formula","javascript","libary","parser","wysiwyg"],"created_at":"2024-10-03T11:19:43.903Z","updated_at":"2024-12-19T12:09:55.616Z","avatar_url":"https://github.com/KennethanCeyer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eformulize :waxing_crescent_moon:\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eformula UI generator\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://nodei.co/npm/formulize/\"\u003e\u003cimg src=\"https://nodei.co/npm/formulize.png\" alt=\"NPM\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://badge.fury.io/js/formulize\"\u003e\u003cimg src=\"https://badge.fury.io/js/formulize.svg\" alt=\"npm version\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://gitter.im/KennethanCeyer/PIGNOSE?utm_source=badge\u0026amp;utm_medium=badge\u0026amp;utm_campaign=pr-badge\u0026amp;utm_content=badge\"\u003e\u003cimg src=\"https://badges.gitter.im/Join%20Chat.svg\" alt=\"Join the chat at https://gitter.im/KennethanCeyer/PIGNOSE\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/KennethanCeyer/formulize/network\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/KennethanCeyer/formulize.svg\" alt=\"GitHub stars\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/KennethanCeyer/formulize/blob/master/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/KennethanCeyer/formulize.svg\" alt=\"GitHub license\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://travis-ci.org/KennethanCeyer/formulize\"\u003e\u003cimg src=\"https://travis-ci.org/KennethanCeyer/formulize.svg?branch=master\" alt=\"Build Status\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://codecov.io/gh/KennethanCeyer/formulize\"\u003e\u003cimg src=\"https://codecov.io/gh/KennethanCeyer/formulize/branch/master/graph/badge.svg\" alt=\"codecov\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://coveralls.io/github/KennethanCeyer/formulize?branch=master\"\u003e\u003cimg src=\"https://coveralls.io/repos/github/KennethanCeyer/formulize/badge.svg?branch=master\" alt=\"Coverage Status\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://codeclimate.com/github/KennethanCeyer/formulize/test_coverage\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/e8bbc8a49edebf28cb2a/test_coverage\" alt=\"Test Coverage\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://codeclimate.com/github/KennethanCeyer/formulize/maintainability\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/e8bbc8a49edebf28cb2a/maintainability\" alt=\"Maintainability\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.codefactor.io/repository/github/kennethanceyer/formulize\"\u003e\u003cimg src=\"https://www.codefactor.io/repository/github/kennethanceyer/formulize/badge\" alt=\"CodeFactor\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## :package: Installation\n\n#### git\n\n```bash\n$ git clone git@github.com:KennethanCeyer/formulize\n```\n\n#### npm\n\n```bash\n$ npm install formulize\n```\n\n### yarn\n\n```bash\n$ yarn add formulize\n```\n\n## :clap: Getting started\n\nThis plugin helps you to make formulas WYSWYG UI\n\n\u003e this plugin is based [metric-parser](https://github.com/KennethanCeyer/metric-parser)\n\n[demo page](http://www.pigno.se/barn/PIGNOSE-Formula)\n\n![Sample screen](http://www.pigno.se/barn/PIGNOSE-Formula/demo/img/screenshot_main.png)\n\n## :page_with_curl: Example (basic)\n\n\n```html\n\u003cdiv id=\"formulize\"\u003e\u003c/div\u003e\n```\n\nIf you want to make UI into `#formulize`\n\n#### typescript\n\n```typescript\nimport { UI } from 'formulize';\n\nconst target = document.getElementById('formulize');\nconst formulize = new UI(target, {\n    ...options\n});\n\nconst data: Tree = {\n    operator: '*',\n    operand1: { value: { type: 'unit', unit: 1 } },\n    operand2: { value: { type: 'unit', unit: 2 } }\n};\n\nformulize.setData(data);\n```  \n\n#### javascript (ES6)\n\n```javascript\nimport { UI } from 'formulize';\n\nconst target = document.getElementById('formulize');\nconst formulize = new UI(target, {\n    ...options\n});\n\nconst data = {\n    operator: '*',\n    operand1: { value: { type: 'unit', unit: 1 } },\n    operand2: { value: { type: 'unit', unit: 2 } }\n};\n\nformulize.setData(data);\n```\n\n#### jQuery\n\n```javascript\n$(function() {\n    $('#formulize').formulize({\n        ...options\n    });\n\n    const formulize = $('#formulize').data('$formulize');\n    const data = {\n        operator: '*',\n        operand1: { value: { type: 'unit', unit: 1 } },\n        operand2: { value: { type: 'unit', unit: 2 } }\n    };\n\n    formulize.setData(data);\n\n    // unrecommended way\n    $('#formulize').setData(data);\n});\n```\n\n## :triangular_flag_on_post: Roadmap\n\n- [x] support typescript\n- [x] update formula tree parser\n- [x] support reference docs\n- [x] follow clean code philosophy\n- [x] follow object based implementation\n- [x] support UMD module\n- [x] support code qualify tool\n- [x] support automation test environment\n- [x] support scss style file\n- [ ] support multiple themes\n- [ ] support unit code to achieve coverage over 90%\n- [ ] support integration testing with mocking dom in the code-level \n- [ ] support e2e testing\n- [ ] add guideline in Github WIKI\n- [ ] add guideline snippet gist and jsfiddle\n- [ ] add contributor guidelines\n- [ ] support cdn\n\n## :mag: License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FKennethanCeyer%2Fformulize.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FKennethanCeyer%2Fformulize?ref=badge_large)\n\nThe MIT License (MIT)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkennethanceyer%2Fformulize","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkennethanceyer%2Fformulize","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkennethanceyer%2Fformulize/lists"}