koffing 0.1.0 → 0.5.0

package/Makefile

@@ -0,0 +1,21 @@
+default:build
+
+clean:
+	rm -rf ./build
+
+build:
+	yarn build
+
+audit-fix:
+	rm -rf package-lock.json ./node_modules
+	npm i --package-lock-only
+	npm audit fix
+	rm -f yarn.lock
+	yarn import
+	rm -f package-lock.json
+
+gh-pages: build
+	npx gh-pages-publish
+
+$(V).SILENT:
+.PHONY: build

package/README.md

@@ -1,10 +1,187 @@
 # Koffing
-
-Koffing is a Pokemon Showdown Team parser that converts your strategies to 
+Koffing is a Pokemon Showdown Team parser that converts your strategies to
 machine-readable JSON code.
 
-## Usage
+![koffing](src/img/koffing.png) 🔁![koffing](src/img/koffing-shiny.png)
+
+[Pokémon Showdown](https://www.pokemonshowdown.com/) is the most popular online Pokémon battle simulator,
+one of the best ways to quickly try your strategies for the official Pokémon VGC Championships. This library is just
+a parser for the teams generated by the [Showdown Team Builder](https://play.pokemonshowdown.com/teambuilder) exports.
+
+This repository holds the source code for the library as well as the code for the Online Parser.
+The [Online Parser](https://itsjavi.github.io/koffing) does not require you to download
+any library or script, it is recommended if all you want is to sanitize, prettify or convert to JSON your
+Showdown team exports.
+
+## Features
+
+- Compatible with web browsers and NodeJS, including ES6+ imports
+- Converts from Showdown code to JSON
+- Converts from JSON to Showdown code
+- Sanitizes Showdown code (removing invalid data, applying max and mins values, etc.)
+- Prettifies Showdown code (proper indentation, line breaks and sorting of the data, etc.)
+- [Online Parser](https://itsjavi.github.io/koffing), which is using the library
+featuring all the above mentioned.
+
+## Installation
 
+As a package:
 ```bash
 npm i --save koffing
-```
+```
+
+In the browser, using a CDN:
+```html
+<script src="https://cdn.rawgit.com/itsjavi/koffing/0.4.0/dist/koffing.min.js"></script>
+```
+
+## Usage
+
+### Javascript (ES5, web)
+```html
+<script src="dist/koffing.min.js"></script>
+<script>
+var teamCode = `=== [gen7] Folder 1/Example Team ===`;
+var parsedTeam = Koffing.parse(teamCode);
+console.log(parsedTeam);
+
+// Note that the ShowdownParser class, which is used internally by the Koffing class
+// is also exposed in the global scope:
+console.log(new ShowdownParser(teamCode).parse());
+</script>
+```
+
+### Javascript (ES6+, universal)
+```js
+"use strict";
+
+import {Koffing} from 'koffing';
+
+const teamCode = `
+=== [gen7] Folder 1/Example Team ===
+
+Smogon (Koffing) (F) @ Eviolite
+Level: 5
+Ability: Levitate
+Shiny: Yes
+Happiness: 255
+EVs: 36 HP / 236 Def / 236 SpD
+IVs: 31 HP / 30 Atk / 31 SpA / 30 SpD / 31 Spe
+Bold Nature
+- Will-O-Wisp
+- Pain Split
+- Sludge Bomb
+- Fire Blast`;
+
+
+let parsedTeam = Koffing.parse(teamCode);
+
+// This will log a PokémonTeamSet object:
+console.log(parsedTeam);
+// Convert it back to the Showdown format (prettified):
+console.log(parsedTeam.toShowdown());
+// which is the same as:
+console.log(parsedTeam.toString());
+// and the same as:
+console.log(parsedTeam + "");
+// You can also convert the object to JSON:
+console.log(parsedTeam.toJson());
+// which is the same as:
+console.log(Koffing.toJson(teamCode));
+```
+
+### NodeJS
+```js
+const Koffing = require('koffing').Koffing;
+
+const teamCode = `=== [gen7] Folder 1/Example Team ===`;
+let parsedTeam = Koffing.parse(teamCode);
+console.log(parsedTeam);
+```
+
+
+## Class Reference
+The `Koffing` class is basically a wrapper of the `ShowdownParser` class, the difference is that it can be used statically.
+
+`ShowdownParser` class methods:
+- `parse(): PokemonTeamSet`: Parses the Showdown code and returns a `PokemonTeamSet` object.
+- `format(): String`: Parses the Showdown code and returns a prettified and sanitized version of it.
+- `toString(): String`: Basically returns the internal Showdown code string as it is.
+
+`Koffing` class methods:
+- `static parse(showdownCode): PokemonTeamSet`: Wrapper for `ShowdownParser.prototype.parse()`
+- `static format(showdownCode): String`: Wrapper for `ShowdownParser.prototype.format()`
+- `static toJson(showdownCode): String`: Wrapper for `ShowdownParser.prototype.parse().toJson()`
+- `static toShowdown(jsonCode): String`: Wrapper for `ShowdownParser.prototype.parse().toShowdown()`
+
+
+## React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+### Available Scripts
+
+In the project directory, you can run:
+
+#### `yarn start`
+
+Runs the app in the development mode.<br />
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br />
+You will also see any lint errors in the console.
+
+#### `yarn test`
+
+Launches the test runner in the interactive watch mode.<br />
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+#### `yarn build`
+
+Builds the app for production to the `build` folder.<br />
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br />
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+#### `yarn eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+### Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+
+## License
+
+This software is copyrighted and licensed under the
+[MIT license](https://github.com/itsjavi/koffing/LICENSE).
+
+### Disclaimer
+
+This software comes bundled with data and graphics extracted from the
+Pokémon series of video games. Some terminology from the Pokémon franchise is
+also necessarily used within the software itself. This is all the intellectual
+property of Nintendo, Creatures, inc., and GAME FREAK, inc. and is protected by
+various copyrights and trademarks.
+
+The authors believe that the use of this intellectual property for a fan reference
+is covered by fair use and that the software is significantly impaired without said
+property included. Any use of this copyrighted property is at your own legal risk.
+
+This software is not affiliated in any way with Nintendo,
+Pokémon or any other game company.
+
+A complete revision history of this software is available from
+https://github.com/itsjavi/koffing

package/build/asset-manifest.json

@@ -0,0 +1,22 @@
+{
+  "files": {
+    "main.css": "/koffing/static/css/main.102b9840.chunk.css",
+    "main.js": "/koffing/static/js/main.07f66bec.chunk.js",
+    "main.js.map": "/koffing/static/js/main.07f66bec.chunk.js.map",
+    "runtime-main.js": "/koffing/static/js/runtime-main.525bb0ff.js",
+    "runtime-main.js.map": "/koffing/static/js/runtime-main.525bb0ff.js.map",
+    "static/js/2.4b3dd85a.chunk.js": "/koffing/static/js/2.4b3dd85a.chunk.js",
+    "static/js/2.4b3dd85a.chunk.js.map": "/koffing/static/js/2.4b3dd85a.chunk.js.map",
+    "index.html": "/koffing/index.html",
+    "precache-manifest.5382b78dea2866c8a94cee003da35d84.js": "/koffing/precache-manifest.5382b78dea2866c8a94cee003da35d84.js",
+    "service-worker.js": "/koffing/service-worker.js",
+    "static/css/main.102b9840.chunk.css.map": "/koffing/static/css/main.102b9840.chunk.css.map",
+    "static/js/2.4b3dd85a.chunk.js.LICENSE.txt": "/koffing/static/js/2.4b3dd85a.chunk.js.LICENSE.txt"
+  },
+  "entrypoints": [
+    "static/js/runtime-main.525bb0ff.js",
+    "static/js/2.4b3dd85a.chunk.js",
+    "static/css/main.102b9840.chunk.css",
+    "static/js/main.07f66bec.chunk.js"
+  ]
+}

package/build/index.html

@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="theme-color" content="#000000"/><title>Koffing - Pokemon Showdown Team parser | Online Pokemon Showdown Team parser</title><link rel="shortcut icon" type="image/png" href="/koffing/favicon.png"/><script async src="https://www.googletagmanager.com/gtag/js?id=UA-85082661-2"></script><script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","UA-85082661-2")</script><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Exo+2:300,400,500"><link href="https://use.fontawesome.com/releases/v5.14.0/css/all.css" rel="stylesheet"><link href="/koffing/static/css/main.102b9840.chunk.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript and a modern browser to run this app.</noscript><div id="root"></div><script>!function(e){function r(r){for(var n,f,i=r[0],l=r[1],a=r[2],c=0,s=[];c<i.length;c++)f=i[c],Object.prototype.hasOwnProperty.call(o,f)&&o[f]&&s.push(o[f][0]),o[f]=0;for(n in l)Object.prototype.hasOwnProperty.call(l,n)&&(e[n]=l[n]);for(p&&p(r);s.length;)s.shift()();return u.push.apply(u,a||[]),t()}function t(){for(var e,r=0;r<u.length;r++){for(var t=u[r],n=!0,i=1;i<t.length;i++){var l=t[i];0!==o[l]&&(n=!1)}n&&(u.splice(r--,1),e=f(f.s=t[0]))}return e}var n={},o={1:0},u=[];function f(r){if(n[r])return n[r].exports;var t=n[r]={i:r,l:!1,exports:{}};return e[r].call(t.exports,t,t.exports,f),t.l=!0,t.exports}f.m=e,f.c=n,f.d=function(e,r,t){f.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},f.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},f.t=function(e,r){if(1&r&&(e=f(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(f.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)f.d(t,n,function(r){return e[r]}.bind(null,n));return t},f.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return f.d(r,"a",r),r},f.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},f.p="/koffing/";var i=this.webpackJsonpkoffing=this.webpackJsonpkoffing||[],l=i.push.bind(i);i.push=r,i=i.slice();for(var a=0;a<i.length;a++)r(i[a]);var p=l;t()}([])</script><script src="/koffing/static/js/2.4b3dd85a.chunk.js"></script><script src="/koffing/static/js/main.07f66bec.chunk.js"></script></body></html>

package/build/precache-manifest.5382b78dea2866c8a94cee003da35d84.js

@@ -0,0 +1,26 @@
+self.__precacheManifest = (self.__precacheManifest || []).concat([
+  {
+    "revision": "98f25614ba5fe5e04f1e0233a92a26c7",
+    "url": "/koffing/index.html"
+  },
+  {
+    "revision": "c500eb4a5760ca0bb4bc",
+    "url": "/koffing/static/css/main.102b9840.chunk.css"
+  },
+  {
+    "revision": "a3524f4864f51e0ac239",
+    "url": "/koffing/static/js/2.4b3dd85a.chunk.js"
+  },
+  {
+    "revision": "3f0e7270d9361d86cdedbbc2d6ca185f",
+    "url": "/koffing/static/js/2.4b3dd85a.chunk.js.LICENSE.txt"
+  },
+  {
+    "revision": "c500eb4a5760ca0bb4bc",
+    "url": "/koffing/static/js/main.07f66bec.chunk.js"
+  },
+  {
+    "revision": "95c593fd36946693659b",
+    "url": "/koffing/static/js/runtime-main.525bb0ff.js"
+  }
+]);

package/build/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

package/build/service-worker.js

@@ -0,0 +1,39 @@
+/**
+ * Welcome to your Workbox-powered service worker!
+ *
+ * You'll need to register this file in your web app and you should
+ * disable HTTP caching for this file too.
+ * See https://goo.gl/nhQhGp
+ *
+ * The rest of the code is auto-generated. Please don't update this file
+ * directly; instead, make changes to your Workbox build configuration
+ * and re-run your build process.
+ * See https://goo.gl/2aRDsh
+ */
+
+importScripts("https://storage.googleapis.com/workbox-cdn/releases/4.3.1/workbox-sw.js");
+
+importScripts(
+  "/koffing/precache-manifest.5382b78dea2866c8a94cee003da35d84.js"
+);
+
+self.addEventListener('message', (event) => {
+  if (event.data && event.data.type === 'SKIP_WAITING') {
+    self.skipWaiting();
+  }
+});
+
+workbox.core.clientsClaim();
+
+/**
+ * The workboxSW.precacheAndRoute() method efficiently caches and responds to
+ * requests for URLs in the manifest.
+ * See https://goo.gl/S9QRab
+ */
+self.__precacheManifest = [].concat(self.__precacheManifest || []);
+workbox.precaching.precacheAndRoute(self.__precacheManifest, {});
+
+workbox.routing.registerNavigationRoute(workbox.precaching.getCacheKeyForURL("/koffing/index.html"), {
+  
+  blacklist: [/^\/_/,/\/[^/?]+\.[^/]+$/],
+});

package/build/static/css/main.102b9840.chunk.css

@@ -0,0 +1,2 @@
+html{box-sizing:border-box;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}*,:after,:before{box-sizing:inherit}body{margin:0;background-color:#fafafa}@media print{body{background-color:#fff}}a{color:#6b71b8}.koffing-sprite{-webkit-animation-name:koffing-animation;animation-name:koffing-animation;-webkit-animation-duration:.7s;animation-duration:.7s;-webkit-animation-iteration-count:infinite;animation-iteration-count:infinite;-webkit-animation-direction:alternate;animation-direction:alternate;-webkit-animation-timing-function:ease-in-out;animation-timing-function:ease-in-out}@-webkit-keyframes koffing-animation{0%{-webkit-transform:translate(0);transform:translate(0)}to{-webkit-transform:translate(-2px,-3px);transform:translate(-2px,-3px)}}@keyframes koffing-animation{0%{-webkit-transform:translate(0);transform:translate(0)}to{-webkit-transform:translate(-2px,-3px);transform:translate(-2px,-3px)}}
+/*# sourceMappingURL=main.102b9840.chunk.css.map */

package/build/static/css/main.102b9840.chunk.css.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.css"],"names":[],"mappings":"AAAA,KACE,qBAAsB,CACtB,kCAAmC,CACnC,iCACF,CAEA,iBACE,kBACF,CAEA,KACE,QAAS,CACT,wBACF,CAEA,aACE,KACE,qBACF,CACF,CAEA,EACE,aACF,CAEA,gBACE,wCAAiC,CAAjC,gCAAiC,CACjC,8BAAyB,CAAzB,sBAAyB,CACzB,0CAAmC,CAAnC,kCAAmC,CACnC,qCAA8B,CAA9B,6BAA8B,CAC9B,6CAAsC,CAAtC,qCACF,CAGA,qCACE,GACE,8BAA8B,CAA9B,sBACF,CACA,GACE,sCAAgC,CAAhC,8BACF,CACF,CAPA,6BACE,GACE,8BAA8B,CAA9B,sBACF,CACA,GACE,sCAAgC,CAAhC,8BACF,CACF","file":"main.102b9840.chunk.css","sourcesContent":["html {\n  box-sizing: border-box;\n  -webkit-font-smoothing: antialiased;\n  -moz-osx-font-smoothing: grayscale;\n}\n\n*, *::before, *::after {\n  box-sizing: inherit;\n}\n\nbody {\n  margin: 0;\n  background-color: #fafafa;\n}\n\n@media print {\n  body {\n    background-color: #fff;\n  }\n}\n\na {\n  color: #6B71B8;\n}\n\n.koffing-sprite {\n  animation-name: koffing-animation;\n  animation-duration: 700ms;\n  animation-iteration-count: infinite;\n  animation-direction: alternate;\n  animation-timing-function: ease-in-out;\n}\n\n/* Standard syntax */\n@keyframes koffing-animation {\n  0% {\n    transform: translate(0px, 0px);\n  }\n  100% {\n    transform: translate(-2px, -3px);\n  }\n}\n"]}