From 7c720e6970f104c8f8969f7ba30db5465c87b561 Mon Sep 17 00:00:00 2001 From: Jungle Date: Mon, 2 Mar 2020 11:17:55 +0500 Subject: [PATCH] feat(common): Add @pyoner/svelte-form-common --- packages/app/package.json | 5 +- packages/app/src/App.svelte | 5 +- packages/common/.editorconfig | 13 + packages/common/.gitignore | 12 + packages/common/.travis.yml | 20 ++ packages/common/CONTRIBUTING.md | 17 + packages/common/LICENSE | 7 + packages/common/README.md | 169 +++++++++ packages/common/code-of-conduct.md | 74 ++++ packages/common/package.json | 125 +++++++ packages/common/rollup.config.ts | 38 +++ packages/common/src/svelte-form-common.ts | 15 + .../common/test/svelte-form-common.test.ts | 14 + packages/common/tools/gh-pages-publish.ts | 31 ++ .../common/tools/semantic-release-prepare.ts | 54 +++ packages/common/tsconfig.json | 22 ++ packages/common/tslint.json | 6 + packages/lib/package.json | 1 + packages/lib/src/components/Form.svelte | 5 +- packages/lib/src/components/Wrapper.svelte | 5 +- .../src/components/fields/ArrayField.svelte | 4 +- packages/lib/src/helpers.ts | 24 +- packages/lib/src/types.ts | 17 +- packages/validators/ajv/package.json | 6 +- .../validators/ajv/src/svelte-form-ajv.ts | 3 +- packages/validators/ajv/tsconfig.json | 1 - pnpm-lock.yaml | 320 ++++++++++++++++-- 27 files changed, 948 insertions(+), 65 deletions(-) create mode 100644 packages/common/.editorconfig create mode 100644 packages/common/.gitignore create mode 100644 packages/common/.travis.yml create mode 100644 packages/common/CONTRIBUTING.md create mode 100644 packages/common/LICENSE create mode 100644 packages/common/README.md create mode 100644 packages/common/code-of-conduct.md create mode 100644 packages/common/package.json create mode 100644 packages/common/rollup.config.ts create mode 100644 packages/common/src/svelte-form-common.ts create mode 100644 packages/common/test/svelte-form-common.test.ts create mode 100644 packages/common/tools/gh-pages-publish.ts create mode 100644 packages/common/tools/semantic-release-prepare.ts create mode 100644 packages/common/tsconfig.json create mode 100644 packages/common/tslint.json diff --git a/packages/app/package.json b/packages/app/package.json index bbe2644..056b9de 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -17,7 +17,7 @@ "rollup-plugin-terser": "^5.2.0", "sirv-cli": "^0.4.5", "svelte": "^3.17.1", - "typescript": "^3.7.5" + "typescript": "^3.8.3" }, "scripts": { "build": "rollup -c", @@ -28,6 +28,7 @@ }, "dependencies": { "@pyoner/svelte-form": "^0.0.0", - "ajv": "^6.11.0" + "@pyoner/svelte-form-ajv": "workspace:^0.0.0", + "ajv": "^6.12.0" } } diff --git a/packages/app/src/App.svelte b/packages/app/src/App.svelte index 7a4f77a..9cb822e 100644 --- a/packages/app/src/App.svelte +++ b/packages/app/src/App.svelte @@ -1,6 +1,7 @@ diff --git a/packages/common/.editorconfig b/packages/common/.editorconfig new file mode 100644 index 0000000..92b9bb1 --- /dev/null +++ b/packages/common/.editorconfig @@ -0,0 +1,13 @@ +#root = true + +[*] +indent_style = space +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +max_line_length = 100 +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false diff --git a/packages/common/.gitignore b/packages/common/.gitignore new file mode 100644 index 0000000..d626d09 --- /dev/null +++ b/packages/common/.gitignore @@ -0,0 +1,12 @@ +node_modules +coverage +.nyc_output +.DS_Store +*.log +.vscode +.idea +dist +compiled +.awcache +.rpt2_cache +docs diff --git a/packages/common/.travis.yml b/packages/common/.travis.yml new file mode 100644 index 0000000..c2e8e10 --- /dev/null +++ b/packages/common/.travis.yml @@ -0,0 +1,20 @@ +language: node_js +cache: + directories: + - ~/.npm +notifications: + email: false +node_js: + - '10' + - '11' + - '8' + - '6' +script: + - npm run test:prod && npm run build +after_success: + - npm run travis-deploy-once "npm run report-coverage" + - if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run travis-deploy-once "npm run deploy-docs"; fi + - if [ "$TRAVIS_BRANCH" = "master" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run travis-deploy-once "npm run semantic-release"; fi +branches: + except: + - /^v\d+\.\d+\.\d+$/ diff --git a/packages/common/CONTRIBUTING.md b/packages/common/CONTRIBUTING.md new file mode 100644 index 0000000..5db2980 --- /dev/null +++ b/packages/common/CONTRIBUTING.md @@ -0,0 +1,17 @@ +We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. πŸ‘ + +## Instructions + +These steps will guide you through contributing to this project: + +- Fork the repo +- Clone it and install dependencies + + git clone https://github.com/YOUR-USERNAME/typescript-library-starter + npm install + +Keep in mind that after running `npm install` the git repo is reset. So a good way to cope with this is to have a copy of the folder to push the changes, and the other to try them. + +Make and commit your changes. Make sure the commands npm run build and npm run test:prod are working. + +Finally send a [GitHub Pull Request](https://github.com/alexjoverm/typescript-library-starter/compare?expand=1) with a clear list of what you've done (read more [about pull requests](https://help.github.com/articles/about-pull-requests/)). Make sure all of your commits are atomic (one feature per commit). diff --git a/packages/common/LICENSE b/packages/common/LICENSE new file mode 100644 index 0000000..aa8bf91 --- /dev/null +++ b/packages/common/LICENSE @@ -0,0 +1,7 @@ +Copyright 2017 Jungle + +Permission 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: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE 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. diff --git a/packages/common/README.md b/packages/common/README.md new file mode 100644 index 0000000..72ac2ef --- /dev/null +++ b/packages/common/README.md @@ -0,0 +1,169 @@ +# TypeScript library starter + +[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) +[![Greenkeeper badge](https://badges.greenkeeper.io/alexjoverm/typescript-library-starter.svg)](https://greenkeeper.io/) +[![Travis](https://img.shields.io/travis/alexjoverm/typescript-library-starter.svg)](https://travis-ci.org/alexjoverm/typescript-library-starter) +[![Coveralls](https://img.shields.io/coveralls/alexjoverm/typescript-library-starter.svg)](https://coveralls.io/github/alexjoverm/typescript-library-starter) +[![Dev Dependencies](https://david-dm.org/alexjoverm/typescript-library-starter/dev-status.svg)](https://david-dm.org/alexjoverm/typescript-library-starter?type=dev) +[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg)](https://paypal.me/AJoverMorales) + +A starter project that makes creating a TypeScript library extremely easy. + +![](https://i.imgur.com/opUmHp0.png) + +### Usage + +```bash +git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME +cd YOURFOLDERNAME + +# Run npm install and write your library name when asked. That's all! +npm install +``` + +**Start coding!** `package.json` and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same name. + +### Features + + - Zero-setup. After running `npm install` things will setup for you :wink: + - **[RollupJS](https://rollupjs.org/)** for multiple optimized bundles following the [standard convention](http://2ality.com/2017/04/setting-up-multi-platform-packages.html) and [Tree-shaking](https://alexjoverm.github.io/2017/03/06/Tree-shaking-with-Webpack-2-TypeScript-and-Babel/) + - Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)** + - **[Prettier](https://github.com/prettier/prettier)** and **[TSLint](https://palantir.github.io/tslint/)** for code formatting and consistency + - **Docs automatic generation and deployment** to `gh-pages`, using **[TypeDoc](http://typedoc.org/)** + - Automatic types `(*.d.ts)` file generation + - **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report + - (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks) + +### Importing library + +You can import the generated bundle to use the whole library generated by this starter: + +```javascript +import myLib from 'mylib' +``` + +Additionally, you can import the transpiled modules from `dist/lib` in case you have a modular library: + +```javascript +import something from 'mylib/dist/lib/something' +``` + +### NPM scripts + + - `npm t`: Run test suite + - `npm start`: Run `npm run build` in watch mode + - `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch) + - `npm run test:prod`: Run linting and generate coverage + - `npm run build`: Generate bundles and typings, create docs + - `npm run lint`: Lints code + - `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:) + +### Excluding peerDependencies + +On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in [Rollup docs](https://rollupjs.org/#peer-dependencies) how to do that. + +Good news: the setup is here for you, you must only include the dependency name in `external` property within `rollup.config.js`. For example, if you want to exclude `lodash`, just write there `external: ['lodash']`. + +### Automatic releases + +_**Prerequisites**: you need to create/login accounts and add your project to:_ + - [npm](https://www.npmjs.com/) + - [Travis CI](https://travis-ci.org) + - [Coveralls](https://coveralls.io) + +_**Prerequisite for Windows**: Semantic-release uses +**[node-gyp](https://github.com/nodejs/node-gyp)** so you will need to +install +[Microsoft's windows-build-tools](https://github.com/felixrieseberg/windows-build-tools) +using this command:_ + +```bash +npm install --global --production windows-build-tools +``` + +#### Setup steps + +Follow the console instructions to install semantic release and run it (answer NO to "Do you want a `.travis.yml` file with semantic-release setup?"). + +_Note: make sure you've setup `repository.url` in your `package.json` file_ + +```bash +npm install -g semantic-release-cli +semantic-release-cli setup +# IMPORTANT!! Answer NO to "Do you want a `.travis.yml` file with semantic-release setup?" question. It is already prepared for you :P +``` + +From now on, you'll need to use `npm run commit`, which is a convenient way to create conventional commits. + +Automatic releases are possible thanks to [semantic release](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library) + +### Git Hooks + +There is already set a `precommit` hook for formatting your code with Prettier :nail_care: + +By default, there are two disabled git hooks. They're set up when you run the `npm run semantic-release-prepare` script. They make sure: + - You follow a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog) + - Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push` + +This makes more sense in combination with [automatic releases](#automatic-releases) + +### FAQ + +#### `Array.prototype.from`, `Promise`, `Map`... is undefined? + +TypeScript or Babel only provides down-emits on syntactical features (`class`, `let`, `async/await`...), but not on functional features (`Array.prototype.find`, `Set`, `Promise`...), . For that, you need Polyfills, such as [`core-js`](https://github.com/zloirock/core-js) or [`babel-polyfill`](https://babeljs.io/docs/usage/polyfill/) (which extends `core-js`). + +For a library, `core-js` plays very nicely, since you can import just the polyfills you need: + +```javascript +import "core-js/fn/array/find" +import "core-js/fn/string/includes" +import "core-js/fn/promise" +... +``` + +#### What is `npm install` doing on first run? + +It runs the script `tools/init` which sets up everything for you. In short, it: + - Configures RollupJS for the build, which creates the bundles + - Configures `package.json` (typings file, main file, etc) + - Renames main src and test files + +#### What if I don't want git-hooks, automatic releases or semantic-release? + +Then you may want to: + - Remove `commitmsg`, `postinstall` scripts from `package.json`. That will not use those git hooks to make sure you make a conventional commit + - Remove `npm run semantic-release` from `.travis.yml` + +#### What if I don't want to use coveralls or report my coverage? + +Remove `npm run report-coverage` from `.travis.yml` + +## Resources + +- [Write a library using TypeScript library starter](https://dev.to/alexjoverm/write-a-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/) +- [πŸ“Ί Create a TypeScript Library using typescript-library-starter](https://egghead.io/lessons/typescript-create-a-typescript-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/) +- [Introducing TypeScript Library Starter Lite](https://blog.tonysneed.com/2017/09/15/introducing-typescript-library-starter-lite/) by [@tonysneed](https://github.com/tonysneed) + +## Projects using `typescript-library-starter` + +Here are some projects that use `typescript-library-starter`: + +- [NOEL - A universal, human-centric, replayable event emitter](https://github.com/lifenautjoe/noel) +- [droppable - A library to give file dropping super-powers to any HTML element.](https://github.com/lifenautjoe/droppable) +- [redis-messaging-manager - Pubsub messaging library, using redis and rxjs](https://github.com/tomyitav/redis-messaging-manager) + +## Credits + +Made with :heart: by [@alexjoverm](https://twitter.com/alexjoverm) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): + + + +| [
Ciro](https://www.linkedin.com/in/ciro-ivan-agullΓ³-guarinos-42109376)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=k1r0s "Code") [πŸ”§](#tool-k1r0s "Tools") | [
Marius Schulz](https://blog.mariusschulz.com)
[πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=mariusschulz "Documentation") | [
Alexander Odell](https://github.com/alextrastero)
[πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=alextrastero "Documentation") | [
Ryan Ham](https://github.com/superamadeus)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=superamadeus "Code") | [
Chi](https://consiiii.me)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Code") [πŸ”§](#tool-ChinW "Tools") [πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Documentation") | [
Matt Mazzola](https://github.com/mattmazzola)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=mattmazzola "Code") [πŸ”§](#tool-mattmazzola "Tools") | [
Sergii Lischuk](http://leefrost.github.io)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=Leefrost "Code") | +| :---: | :---: | :---: | :---: | :---: | :---: | :---: | +| [
Steve Lee](http;//opendirective.com)
[πŸ”§](#tool-SteveALee "Tools") | [
Flavio Corpa](http://flaviocorpa.com)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=kutyel "Code") | [
Dom](https://github.com/foreggs)
[πŸ”§](#tool-foreggs "Tools") | [
Alex Coles](http://alexbcoles.com)
[πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=myabc "Documentation") | [
David Khourshid](https://github.com/davidkpiano)
[πŸ”§](#tool-davidkpiano "Tools") | [
AarΓ³n GarcΓ­a HervΓ‘s](https://aarongarciah.com)
[πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=aarongarciah "Documentation") | [
Jonathan Hart](https://www.stuajnht.co.uk)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=stuajnht "Code") | +| [
Sanjiv Lobo](https://github.com/Xndr7)
[πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=Xndr7 "Documentation") | [
Stefan Aleksovski](https://github.com/sAleksovski)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=sAleksovski "Code") | [
dev.peerapong](https://github.com/devpeerapong)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=devpeerapong "Code") | [
Aaron Groome](http://twitter.com/Racing5372)
[πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=Racing5372 "Documentation") | [
Aaron Reisman](https://github.com/lifeiscontent)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=lifeiscontent "Code") | [
kid-sk](https://github.com/kid-sk)
[πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=kid-sk "Documentation") | [
Andrea Gottardi](http://about.me/andreagot)
[πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=AndreaGot "Documentation") | +| [
Yogendra Sharma](http://TechiesEyes.com)
[πŸ“–](https://github.com/alexjoverm/typescript-library-starter/commits?author=Yogendra0Sharma "Documentation") | [
Rayan Salhab](http://linkedin.com/in/rayan-salhab/)
[πŸ’»](https://github.com/alexjoverm/typescript-library-starter/commits?author=cyphercodes "Code") | + + +This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome! diff --git a/packages/common/code-of-conduct.md b/packages/common/code-of-conduct.md new file mode 100644 index 0000000..4a9568b --- /dev/null +++ b/packages/common/code-of-conduct.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at alexjovermorales@gmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/packages/common/package.json b/packages/common/package.json new file mode 100644 index 0000000..ce44638 --- /dev/null +++ b/packages/common/package.json @@ -0,0 +1,125 @@ +{ + "name": "@pyoner/svelte-form-common", + "version": "0.0.0", + "description": "", + "keywords": [], + "main": "dist/svelte-form-common.umd.js", + "module": "dist/svelte-form-common.es5.js", + "typings": "dist/types/svelte-form-common.d.ts", + "files": [ + "dist" + ], + "author": "Jungle ", + "repository": { + "type": "git", + "url": "" + }, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + }, + "scripts": { + "lint": "tslint --project tsconfig.json -t codeFrame 'src/**/*.ts' 'test/**/*.ts'", + "prebuild": "rimraf dist", + "build": "tsc --module commonjs && rollup -c rollup.config.ts && typedoc --out docs --target es6 --theme minimal --mode file src", + "start": "rollup -c rollup.config.ts -w", + "test": "jest --coverage", + "test:watch": "jest --coverage --watch", + "test:prod": "npm run lint && npm run test -- --no-cache", + "deploy-docs": "ts-node tools/gh-pages-publish", + "report-coverage": "cat ./coverage/lcov.info | coveralls", + "commit": "git-cz", + "semantic-release": "semantic-release", + "semantic-release-prepare": "ts-node tools/semantic-release-prepare", + "precommit": "lint-staged", + "travis-deploy-once": "travis-deploy-once", + "prepare": "npm run build" + }, + "lint-staged": { + "{src,test}/**/*.ts": [ + "prettier --write", + "git add" + ] + }, + "config": { + "commitizen": { + "path": "node_modules/cz-conventional-changelog" + } + }, + "jest": { + "transform": { + ".(ts|tsx)": "ts-jest" + }, + "testEnvironment": "node", + "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$", + "moduleFileExtensions": [ + "ts", + "tsx", + "js" + ], + "coveragePathIgnorePatterns": [ + "/node_modules/", + "/test/" + ], + "coverageThreshold": { + "global": { + "branches": 90, + "functions": 95, + "lines": 95, + "statements": 95 + } + }, + "collectCoverageFrom": [ + "src/*.{js,ts}" + ] + }, + "prettier": { + "semi": false, + "singleQuote": true + }, + "commitlint": { + "extends": [ + "@commitlint/config-conventional" + ] + }, + "devDependencies": { + "@commitlint/cli": "^7.1.2", + "@commitlint/config-conventional": "^7.1.2", + "@types/jest": "^23.3.2", + "@types/node": "^10.11.0", + "colors": "^1.3.2", + "commitizen": "^3.0.0", + "coveralls": "^3.0.2", + "cross-env": "^5.2.0", + "cz-conventional-changelog": "^2.1.0", + "husky": "^1.0.1", + "jest": "^23.6.0", + "jest-config": "^23.6.0", + "lint-staged": "^8.0.0", + "lodash.camelcase": "^4.3.0", + "prettier": "^1.14.3", + "prompt": "^1.0.0", + "replace-in-file": "^3.4.2", + "rimraf": "^2.6.2", + "rollup": "^0.67.0", + "rollup-plugin-commonjs": "^9.1.8", + "rollup-plugin-json": "^3.1.0", + "rollup-plugin-node-resolve": "^3.4.0", + "rollup-plugin-sourcemaps": "^0.4.2", + "rollup-plugin-typescript2": "^0.18.0", + "semantic-release": "^15.9.16", + "shelljs": "^0.8.3", + "travis-deploy-once": "^5.0.9", + "ts-jest": "^23.10.2", + "ts-node": "^7.0.1", + "tslint": "^5.11.0", + "tslint-config-prettier": "^1.15.0", + "tslint-config-standard": "^8.0.1", + "typedoc": "^0.12.0", + "typescript": "^3.0.3" + }, + "dependencies": { + "@types/json-schema": "^7.0.4", + "json-schema-typed": "^7.0.3" + } +} diff --git a/packages/common/rollup.config.ts b/packages/common/rollup.config.ts new file mode 100644 index 0000000..a653639 --- /dev/null +++ b/packages/common/rollup.config.ts @@ -0,0 +1,38 @@ +import resolve from 'rollup-plugin-node-resolve' +import commonjs from 'rollup-plugin-commonjs' +import sourceMaps from 'rollup-plugin-sourcemaps' +import camelCase from 'lodash.camelcase' +import typescript from 'rollup-plugin-typescript2' +import json from 'rollup-plugin-json' + +const pkg = require('./package.json') + +const libraryName = 'svelte-form-common' + +export default { + input: `src/${libraryName}.ts`, + output: [ + { file: pkg.main, name: camelCase(libraryName), format: 'umd', sourcemap: true }, + { file: pkg.module, format: 'es', sourcemap: true }, + ], + // Indicate here external modules you don't wanna include in your bundle (i.e.: 'lodash') + external: [], + watch: { + include: 'src/**', + }, + plugins: [ + // Allow json resolution + json(), + // Compile TypeScript files + typescript({ useTsconfigDeclarationDir: true }), + // Allow bundling cjs modules (unlike webpack, rollup doesn't understand cjs) + commonjs(), + // Allow node_modules resolution, so you can use 'external' to control + // which external modules to include in the bundle + // https://github.com/rollup/rollup-plugin-node-resolve#usage + resolve(), + + // Resolve source maps to the original source + sourceMaps(), + ], +} diff --git a/packages/common/src/svelte-form-common.ts b/packages/common/src/svelte-form-common.ts new file mode 100644 index 0000000..4198cd9 --- /dev/null +++ b/packages/common/src/svelte-form-common.ts @@ -0,0 +1,15 @@ +import { JSONSchema } from 'json-schema-typed' + +export { JSONSchema } + +export const supportedTypes = ['array', 'boolean', 'null', 'number', 'object', 'string'] + +export type JSONObject = Record + +export interface ErrorRecord { + [k: string]: Error[] | ErrorRecord +} + +export type Errors = ErrorRecord | Error[] + +export type Validator = (schema: JSONSchema, data: any) => Errors | null diff --git a/packages/common/test/svelte-form-common.test.ts b/packages/common/test/svelte-form-common.test.ts new file mode 100644 index 0000000..32206cd --- /dev/null +++ b/packages/common/test/svelte-form-common.test.ts @@ -0,0 +1,14 @@ +import DummyClass from "../src/svelte-form-common" + +/** + * Dummy test + */ +describe("Dummy test", () => { + it("works if true is truthy", () => { + expect(true).toBeTruthy() + }) + + it("DummyClass is instantiable", () => { + expect(new DummyClass()).toBeInstanceOf(DummyClass) + }) +}) diff --git a/packages/common/tools/gh-pages-publish.ts b/packages/common/tools/gh-pages-publish.ts new file mode 100644 index 0000000..ede555b --- /dev/null +++ b/packages/common/tools/gh-pages-publish.ts @@ -0,0 +1,31 @@ +const { cd, exec, echo, touch } = require("shelljs") +const { readFileSync } = require("fs") +const url = require("url") + +let repoUrl +let pkg = JSON.parse(readFileSync("package.json") as any) +if (typeof pkg.repository === "object") { + if (!pkg.repository.hasOwnProperty("url")) { + throw new Error("URL does not exist in repository section") + } + repoUrl = pkg.repository.url +} else { + repoUrl = pkg.repository +} + +let parsedUrl = url.parse(repoUrl) +let repository = (parsedUrl.host || "") + (parsedUrl.path || "") +let ghToken = process.env.GH_TOKEN + +echo("Deploying docs!!!") +cd("docs") +touch(".nojekyll") +exec("git init") +exec("git add .") +exec('git config user.name "Jungle"') +exec('git config user.email "devex.soft@gmail.com"') +exec('git commit -m "docs(docs): update gh-pages"') +exec( + `git push --force --quiet "https://${ghToken}@${repository}" master:gh-pages` +) +echo("Docs deployed!!") diff --git a/packages/common/tools/semantic-release-prepare.ts b/packages/common/tools/semantic-release-prepare.ts new file mode 100644 index 0000000..db14dd7 --- /dev/null +++ b/packages/common/tools/semantic-release-prepare.ts @@ -0,0 +1,54 @@ +const path = require("path") +const { fork } = require("child_process") +const colors = require("colors") + +const { readFileSync, writeFileSync } = require("fs") +const pkg = JSON.parse( + readFileSync(path.resolve(__dirname, "..", "package.json")) +) + +pkg.scripts.prepush = "npm run test:prod && npm run build" +pkg.scripts.commitmsg = "commitlint -E HUSKY_GIT_PARAMS" + +writeFileSync( + path.resolve(__dirname, "..", "package.json"), + JSON.stringify(pkg, null, 2) +) + +// Call husky to set up the hooks +fork(path.resolve(__dirname, "..", "node_modules", "husky", "lib", "installer", 'bin'), ['install']) + +console.log() +console.log(colors.green("Done!!")) +console.log() + +if (pkg.repository.url.trim()) { + console.log(colors.cyan("Now run:")) + console.log(colors.cyan(" npm install -g semantic-release-cli")) + console.log(colors.cyan(" semantic-release-cli setup")) + console.log() + console.log( + colors.cyan('Important! Answer NO to "Generate travis.yml" question') + ) + console.log() + console.log( + colors.gray( + 'Note: Make sure "repository.url" in your package.json is correct before' + ) + ) +} else { + console.log( + colors.red( + 'First you need to set the "repository.url" property in package.json' + ) + ) + console.log(colors.cyan("Then run:")) + console.log(colors.cyan(" npm install -g semantic-release-cli")) + console.log(colors.cyan(" semantic-release-cli setup")) + console.log() + console.log( + colors.cyan('Important! Answer NO to "Generate travis.yml" question') + ) +} + +console.log() diff --git a/packages/common/tsconfig.json b/packages/common/tsconfig.json new file mode 100644 index 0000000..215a7f1 --- /dev/null +++ b/packages/common/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "moduleResolution": "node", + "target": "es5", + "module":"es2015", + "lib": ["es2015", "es2016", "es2017", "dom"], + "strict": true, + "sourceMap": true, + "declaration": true, + "allowSyntheticDefaultImports": true, + "experimentalDecorators": true, + "emitDecoratorMetadata": true, + "declarationDir": "dist/types", + "outDir": "dist/lib", + "typeRoots": [ + "node_modules/@types" + ] + }, + "include": [ + "src" + ] +} diff --git a/packages/common/tslint.json b/packages/common/tslint.json new file mode 100644 index 0000000..398a416 --- /dev/null +++ b/packages/common/tslint.json @@ -0,0 +1,6 @@ +{ + "extends": [ + "tslint-config-standard", + "tslint-config-prettier" + ] +} \ No newline at end of file diff --git a/packages/lib/package.json b/packages/lib/package.json index 49268fc..ff4ad96 100644 --- a/packages/lib/package.json +++ b/packages/lib/package.json @@ -82,6 +82,7 @@ "devDependencies": { "@commitlint/cli": "^8.3.5", "@commitlint/config-conventional": "^8.3.4", + "@pyoner/svelte-form-common": "workspace:^0.0.0", "@pyoner/svelte-ts-preprocess": "^1.2.1", "@types/jest": "^24.9.0", "@types/json-schema": "^7.0.4", diff --git a/packages/lib/src/components/Form.svelte b/packages/lib/src/components/Form.svelte index c64ecb7..f07eb30 100644 --- a/packages/lib/src/components/Form.svelte +++ b/packages/lib/src/components/Form.svelte @@ -1,10 +1,11 @@ diff --git a/packages/lib/src/components/fields/ArrayField.svelte b/packages/lib/src/components/fields/ArrayField.svelte index b251359..6c18dfd 100644 --- a/packages/lib/src/components/fields/ArrayField.svelte +++ b/packages/lib/src/components/fields/ArrayField.svelte @@ -1,8 +1,8 @@