applib - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

changelog.md

@@ -0,1 +1,5 @@
+### v1.2.1
+- Fix: center widened image captions from Parsoid
+- Chore: update CollapseTable tests to be more consistent
+
 ### v1.2.0
@@ -2,0 +6,0 @@ - New: JS and CSS for image widening transform

package.json

 {
   "name": "applib",
-  "version": "1.2.0",
-  "description": "Cross-platform JavaScript library for Wikimedia apps",
+  "version": "1.2.1",
+  "description": "Cross-platform JavaScript and CSS library for Wikimedia apps",
   "keywords": [
@@ -14,3 +14,5 @@ "Wikipedia",
     "Android",
-    "iOS"
+    "iOS",
+    "JavaScript",
+    "CSS"
   ],
@@ -23,3 +25,3 @@ "homepage": "https://github.com/wikimedia/applib",
     "lint": "eslint --cache --max-warnings 0 --ext .js --ext .json",
-    "prebuild": "npm run -s lint .",
+    "lint:all": "npm run -s lint .",
     "build": "rollup -c",
@@ -30,5 +32,10 @@ "pretest": "npm run -s build",
     "preversion": "[ -z \"$(git status -z)\" ]",
-    "postversion": "git push origin master --follow-tags && npm publish",
+    "postversion": "git push --follow-tags origin HEAD && npm publish",
+    "prepublish": "npm run -s lint:all && npm run -s clean && npm -s t",
     "upgrade": "ncu -au"
   },
+  "pre-commit": [
+    "lint:all",
+    "test"
+  ],
   "engines": {
@@ -35,0 +42,0 @@ "node": "7.5.0"

readme.md

 # applib
-Cross-platform JavaScript library for Wikimedia apps
+Library for common JavaScript transforms and CSS used by both the Android and iOS Wikipedia apps
 
+## Background
+Presently we are consolidating duplicate Android and iOS Wikipedia app implementations of certain JavaScript transformations, such as image widening. **Applib** is where we are placing these consolidated JavaScript transform implementations. 
+
+## What Applib is for
+* JavaScript transforms common to **both** the Android and iOS Wikipedia apps.
+
+## What Applib is not for
+* Android or iOS **specific** JS or CSS.
+* CSS unrelated to a particular JavaScript transform. *In the future we may re-evaluate this for CSS common between the Android and iOS apps, but for right now the only CSS in Applib should be CSS directly needed by a particular JavaScript transform.*
+
+## What Applib delivers
+* **applib.js** bundle of all transform JS
+* **applib.css** bundle of all CSS required by the bundled transform JS
+
+## Conventions
+
+### File locations and naming
+
+Example file names and locations for an image widening transform:
+* **src/WidenImage.js** - the transform. *required*
+* **src/WidenImage.css** - CSS used by the transform. *optional*
+* **test/WidenImage.js** - tests of the transform. *required*
+* **test/fixtures/WidenImage.html** - fixtures used by transform tests. *optional*
+
+### Changing styles
+- Prefer to modify classlist rather than style attributes. For example, **WidenImage.js** mentioned above could add/remove a class name from **WidenImage.css** to an element's classlist to help achieve image widening.
+
+### Function naming
+*Coming soon.*
+
+### Style naming
+*Coming soon.*
+
+## Development setup and workflow
+*Coming soon.*
+
 ## [Changelog](changelog.md)
@@ -5,0 +41,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

32793

increased by6.45%

Lines of code

220

increased by1.85%

Number of lines in readme file

54

increased by200%

No dependency changes