diff --git a/.builderrc b/.builderrc new file mode 100644 index 0000000..7218a72 --- /dev/null +++ b/.builderrc @@ -0,0 +1,3 @@ +--- +archetypes: + - builder-js-package diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..8290e61 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +# EditorConfig is awesome: http://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 4 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..82ffc5a --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +node_modules/ +package-lock.json +dist/ +.vscode/ + +*.log +**/.rush/ diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..910b461 --- /dev/null +++ b/.npmignore @@ -0,0 +1,6 @@ +# this file is copied into the dist/ after build, and the lib is published +# relative to the dist/ folder. +/**/*.test.js +/**/*.test.js.map +/**/*.test.d.ts +/tests/ diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..43c97e7 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..b947077 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,2 @@ +node_modules/ +dist/ diff --git a/.prettierrc.js b/.prettierrc.js new file mode 100644 index 0000000..dffccfe --- /dev/null +++ b/.prettierrc.js @@ -0,0 +1,10 @@ +module.exports = { + tabWidth: 4, + useTabs: true, + semi: false, + singleQuote: true, + trailingComma: 'all', + bracketSpacing: false, + printWidth: 120, + arrowParens: 'avoid', +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1c53bf0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Joseph Orbegoso Pea (joe@trusktr.io) + +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/README.md b/README.md new file mode 100644 index 0000000..f3aa6e7 --- /dev/null +++ b/README.md @@ -0,0 +1,302 @@ +# @lume/element + +Create Custom Elements with reactivity and automatic re-rendering. + +#### `npm install @lume/element --save` + +## Intro + +[Custom](https://developers.google.com/web/fundamentals/web-components/customelements) +[Elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) +(also known as [Web +Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) are +a feature of browsers that allow us to define new HTML elements that the +browser understands in the same way as built-in elements like `
` or +`