Skip to content

Prepare the library to be released as a npm package #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Oct 10, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
},
"globals": {
"dataValues": false,
"module": false,
"util": false,
"wikibase": false
},
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
composer.lock
vendor/
node_modules/
package-lock.json

.idea/
20 changes: 9 additions & 11 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
language: php
language: node_js

php:
- 5.5
node_js:
- 4
- 5
- 6
- 7
- 8

sudo: false

before_script:
- composer install --prefer-source
- nvm install 4
- npm install

script:
- composer test
- npm install && npm run eslint
- npm run test

notifications:
irc:
Expand All @@ -21,7 +23,3 @@ notifications:
on_failure: always
template:
- "%{repository}/%{branch}/%{commit} : %{author} %{message} %{build_url}"

cache:
directories:
- $HOME/.composer/cache
20 changes: 3 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,13 @@

JavaScript library containing serializers and deserializers for the Wikibase DataModel.

## Installation

The recommended way to use this library is via [Composer](http://getcomposer.org/).

To add this package as a local, per-project dependency to your project, simply add a
dependency on `wikibase/serialization-javascript` to your project's `composer.json` file.
Here is a minimal example of a `composer.json` file that just defines a dependency on
version 2.0 of this package:

```json
{
"require": {
"wikibase/serialization-javascript": "2.0.*"
}
}
```

## Release notes

### 3.0.0 (dev)

* Made the library a pure JavaScript library.
* Removed MediaWiki ResourceLoader module definitions.
* Raised DataValues JS library version requirement to 0.10.0, and Wikibase Data Model JS library version requirement to 4.0.0.
* Removed all serializers and deserializers for Claim collections:
* Removed ClaimGroupDeserializer
* Removed ClaimGroupSerializer
Expand Down
37 changes: 0 additions & 37 deletions composer.json

This file was deleted.

12 changes: 0 additions & 12 deletions init.mw.php

This file was deleted.

9 changes: 0 additions & 9 deletions init.php

This file was deleted.

44 changes: 44 additions & 0 deletions karma.conf.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
module.exports = function ( config ) {
config.set( {
frameworks: [ 'qunit' ],

files: [
'node_modules/jquery/dist/jquery.js',

// TODO: install JS dependencies using npm
'node_modules/wikibase-data-values/lib/util/util.inherit.js',
'node_modules/wikibase-data-values/src/dataValues.js',
'node_modules/wikibase-data-values/src/DataValue.js',
'node_modules/wikibase-data-values/src/values/StringValue.js',
'node_modules/wikibase-data-values/src/values/UnDeserializableValue.js',
'node_modules/wikibase-data-model/src/__namespace.js',
'node_modules/wikibase-data-model/src/GroupableCollection.js',
'node_modules/wikibase-data-model/src/Group.js',
'node_modules/wikibase-data-model/src/Snak.js',
'node_modules/wikibase-data-model/src/Set.js',
'node_modules/wikibase-data-model/src/List.js',
'node_modules/wikibase-data-model/src/*.js',

'src/__namespace.js',
'src/Serializers/Serializer.js',
'src/Serializers/*.js',
'src/SerializerFactory.js',
'src/StrategyProvider.js',
'src/Deserializers/Deserializer.js',
'src/Deserializers/*.js',
'src/DeserializerFactory.js',
'tests/MockEntity.js',
'tests/MockEntity.tests.js',
'tests/StrategyProvider.tests.js',
'tests/SerializerFactory.tests.js',
'tests/Serializers/*.js',
'tests/Deserializers/*.js',
'tests/DeserializerFactory.tests.js'
],

port: 9876,

logLevel: config.LOG_INFO,
browsers: [ 'PhantomJS' ]
} );
};
12 changes: 0 additions & 12 deletions mediawiki-extension.json

This file was deleted.

39 changes: 37 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,48 @@
{
"name": "wikibase-serialization",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, tab-indention should be the norm for .json files. But this is for later.

"description": "Wikibase datamodel serialization implementation in JavaScript",
"license": "GPL-2.0+",
"contributors": [
{
"name": "H. Snater",
"url": "http://www.snater.com"
},
{
"name": "Adrian Lang",
"email": "adrian.lang@wikimedia.de"
}
],
"repository": {
"type": "git",
"url": "https://github.com/wmde/WikibaseSerializationJavaScript"
},
"bugs": {
"url": "https://phabricator.wikimedia.org/"
},
"directories": {
"lib": "src",
"test": "tests"
},
"support": {
"url": "https://phabricator.wikimedia.org/"
},
"dependencies": {
"jquery": "^3.2.1",
"wikibase-data-model": "^4.0.0",
"wikibase-data-values": "^0.10.0"
},
"devDependencies": {
"eslint": "^3.19.0",
"eslint-config-wikimedia": "0.4.0"
"eslint-config-wikimedia": "0.4.0",
"karma": "^1.7.1",
"karma-cli": "^1.0.1",
"karma-phantomjs-launcher": "^1.0.4",
"karma-qunit": "^1.2.1",
"qunit": "^1.0.0"
},
"scripts": {
"eslint": "eslint ."
"test": "npm run eslint && npm run run-tests",
"eslint": "eslint .",
"run-tests": "karma start --single-run"
}
}
16 changes: 0 additions & 16 deletions resources.php

This file was deleted.

17 changes: 0 additions & 17 deletions resources.tests.php

This file was deleted.

Loading