Skip to content

Commit

Permalink
Release 4.0.0 (#71)
Browse files Browse the repository at this point in the history
* fresh start 🌑

* initial project setup for europa

* added notice to readme warning about development status

* initial work for structuring europa

* small reordering within package.json

* simplified dist structure

* bumped version

* improved branding

* fixed rollup build and made compatible with core exports

* moved runtime dependencies to devDependencies

* bumped eslint-config-skelp and europa-core

* switched to ES5 to avoid having to compile using babel and to reduce distribution file size

* roll 4.0.0-alpha9 after move to !ninja and rewrite to match new europa-core design

* corrected link in README

* documented API

* minor formatting change to demo.html

* added live demo badge to README

* preparing for 4.0.0 release

* roll 4.0.0
  • Loading branch information
neocotic committed Jun 9, 2017
1 parent 0235b57 commit c9743b2
Show file tree
Hide file tree
Showing 53 changed files with 5,613 additions and 3,585 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
root = true

This comment has been minimized.

Copy link
@irshad110

irshad110 Jul 25, 2021

[*]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
dist/
Gruntfile.js
15 changes: 15 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"extends": "notninja/es5",
"env": {
"browser": true,
"node": true
},
"rules": {
"no-unused-vars": [
"error",
{
"args": "none"
}
]
}
}
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text eol=lf
8 changes: 1 addition & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,2 @@
node_modules/
npm-debug.log
tmp/

.DS_Store?
ehthumbs.db
Icon?
Thumbs.db
*.log
10 changes: 10 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
src/
test/
.*
AUTHORS.md
bower.json
CHANGES.md
CONTRIBUTING.md
demo.html
Gruntfile.js
README.md
14 changes: 12 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
sudo: false
language: node_js
node_js:
- 0.8
- "4"
- "6"
- "8"
before_script:
- npm install -g grunt-cli
- npm install -g npm@latest
script:
- npm run ci
notifications:
slack:
rooms:
- secure: WHQ5tkFTGNfiVP3ukCgpJ7ublarl7XYYa4WRuTeU/S+yIUAYLDUyrI1WfAh4oRhLvrqXPL62qsqKbAnNIkUcybvpig7VFddJWJot+RpVICKYuatHNNM/PIhRxyfkYwAX22IkM9d9e3FzAEMywE9uiIZviignh0E7r9wYfDhCSxY=
on_success: change
2 changes: 0 additions & 2 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Authors ordered by first contribution

* Trevor Jim <trever@research.att.com>
* Alasdair Mercer <mercer.alasdair@gmail.com>
* Tim Chaplin <tjchaplin@hotmail.com>
93 changes: 54 additions & 39 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,84 @@
## Version 4.0.0, 2017.06.09

* Rename library to Europa :new_moon: and move package from `html-md` to `europa`
* Rewrite entire code base from ground up and adopt OOP pattern (no more CoffeeScript)
* Release fresh code base under MIT license
* Split into multiple modules (`europa` for browser, `node-europa` for Node.js, `europa-core` to support all environments, `europa-test` for testing)
* Add support for plugins (and the concept of presets)
* Restructure code base to make it more maintainable
* Remove documentation generated by `docco`
* Add `.editorconfig` to help contributors using compatible editors
* Remove `INSTALL.md` and consolidate contents into `README.md` and `CONTRIBUTING.md`
* Switch to container-based Travis builds for faster boot times
* Remove `noConflict` method
* Remove `version` field

### Specific to `europa`

* Change global variable to `Europa`
* Use [Rollup](http://rollupjs.org) to bundle source code into distribution files
* Replace `component.json` with `bower.json` for proper [Bower](https://bower.io) support
* Add `demo.html` to allow contributors to experiment and test changes locally
* Add live demo link to `README.md`
* Add download links to `README.md` for browser distribution files

## Version 3.1.0, 2016.09.02

* [#39](https://github.com/neocotic/html.md/issues/39): Fix support for AMD
* [#66](https://github.com/neocotic/html.md/issues/66): Correct license to GPL-2.0
* Fix support for AMD [#39](https://github.com/NotNinja/europa/issues/39)
* Correct license to GPL-2.0 [#66](https://github.com/NotNinja/europa/issues/66)

## Version 3.0.2, 2013.10.09

* [#36](https://github.com/neocotic/html.md/issues/36): Fix errors in Internet Explorer 8 and older
* [#37](https://github.com/neocotic/html.md/issues/37): Fix problem with running command line
* Fix errors in Internet Explorer 8 and older [#36](https://github.com/NotNinja/europa/issues/36)
* Fix problem with running command line [#37](https://github.com/NotNinja/europa/issues/37)
* Update versions on dependencies
* Minor changes and tweaks

## Version 3.0.1, 2013.08.16

* [#33](https://github.com/neocotic/html.md/issues/33): Fix handling of unformatted HTML lists
* Fix handling of unformatted HTML lists [#33](https://github.com/NotNinja/europa/issues/33)

## Version 3.0.0, 2013.08.15

* [#30](https://github.com/neocotic/html.md/issues/30): Rename command from `md` to `html-md`
* [#31](https://github.com/neocotic/html.md/issues/31): Correct expectations of void elements
* Rename command from `md` to `html-md` [#30](https://github.com/NotNinja/europa/issues/30)
* Correct expectations of void elements [#31](https://github.com/NotNinja/europa/issues/31)
* Update versions of dependencies

## Version 2.1.1, 2013.05.06

* [#24](https://github.com/neocotic/html.md/issues/24): Add `base` option to specify the base URL used to resolve relative URLs
* Add `base` option to specify the base URL used to resolve relative URLs [#24](https://github.com/NotNinja/europa/issues/24)

## Version 2.1.0, 2013.05.03

* [#18](https://github.com/neocotic/html.md/issues/18): Add support for [bower][] installations
* [#20](https://github.com/neocotic/html.md/issues/20): Replace `Cakefile` with new [grunt][] build process
* [#20](https://github.com/neocotic/html.md/issues/20): Replace [tap][] test framework with [nodeunit][]
* [#21](https://github.com/neocotic/html.md/issues/21): Remove [CoffeeScript][] as a runtime dependency
* [#21](https://github.com/neocotic/html.md/issues/21): Update [jsdom][] to v0.6.0 to fix known bugs
* [#21](https://github.com/neocotic/html.md/issues/21): Improve compatibility with the Windows platform
* [#21](https://github.com/neocotic/html.md/issues/21): Improve code and documentation quality and standards
* [#21](https://github.com/neocotic/html.md/issues/21): Fix `absolute` option to also apply to `img` elements
* [#21](https://github.com/neocotic/html.md/issues/21): Improve compatibility with older browsers
* [#22](https://github.com/neocotic/html.md/issues/22): Improve handling of ordered and unodered lists
* [#22](https://github.com/neocotic/html.md/issues/22): Support nested lists
* [#23](https://github.com/neocotic/html.md/issues/23): Add option to support inline link style
* Replace [optparse][] with [commander][]
* Add support for [bower](http://twitter.github.io/bower/) installations [#18](https://github.com/NotNinja/europa/issues/18)
* Replace `Cakefile` with new [grunt](http://gruntjs.com) build process [#20](https://github.com/NotNinja/europa/issues/20)
* Replace [tap](https://github.com/isaacs/node-tap) test framework with [nodeunit](https://github.com/caolan/nodeunit) [#20](https://github.com/NotNinja/europa/issues/20)
* Remove [CoffeeScript](http://coffeescript.org) as a runtime dependency [#21](https://github.com/NotNinja/europa/issues/21)
* Update [jsdom](https://github.com/tmpvar/jsdom) to v0.6.0 to fix known bugs [#21](https://github.com/NotNinja/europa/issues/21)
* Improve compatibility with the Windows platform [#21](https://github.com/NotNinja/europa/issues/21)
* Improve code and documentation quality and standards [#21](https://github.com/NotNinja/europa/issues/21)
* Fix `absolute` option to also apply to `img` elements [#21](https://github.com/NotNinja/europa/issues/21)
* Improve compatibility with older browsers [#21](https://github.com/NotNinja/europa/issues/21)
* Improve handling of ordered and unordered lists [#22](https://github.com/NotNinja/europa/issues/22)
* Support nested lists [#22](https://github.com/NotNinja/europa/issues/22)
* Add option to support inline link style [#23](https://github.com/NotNinja/europa/issues/23)
* Replace [optparse](https://github.com/jfd/optparse-js) with [commander](http://visionmedia.github.io/commander.js/)
* Lots of bug fixes and optimizations

## Version 2.0.2, 2013.02.04

* [#13](https://github.com/neocotic/html.md/issues/13): Add new man page
* [#14](https://github.com/neocotic/html.md/issues/14): Fix bug with `eval` option
* Add new man page [#13](https://github.com/NotNinja/europa/issues/13)
* Fix bug with `eval` option [#14](https://github.com/NotNinja/europa/issues/14)

## Version 2.0.1, 2012.12.12

* [#8](https://github.com/neocotic/html.md/issues/8): Fix incorrect version
* Fix incorrect version [#8](https://github.com/NotNinja/europa/issues/8)

## Version 2.0.0, 2012.12.11

* [#1](https://github.com/neocotic/html.md/issues/1): Check inline style attribute to see if elements are hidden
* [#2](https://github.com/neocotic/html.md/issues/2): Add command line interface
* [#3](https://github.com/neocotic/html.md/issues/3): Create unit test suite
* [#4](https://github.com/neocotic/html.md/issues/4): Rewrite code in CoffeeScript
* [#5](https://github.com/neocotic/html.md/issues/5): Add compatibility support for node.js
* [#6](https://github.com/neocotic/html.md/issues/6): Add build process

[bower]: http://twitter.github.io/bower/
[coffeescript]: http://coffeescript.org
[commander]: http://visionmedia.github.io/commander.js/
[grunt]: http://gruntjs.com
[jsdom]: https://github.com/tmpvar/jsdom
[nodeunit]: https://github.com/caolan/nodeunit
[optparse]: https://github.com/jfd/optparse-js
[tap]: https://github.com/isaacs/node-tap
* Check inline style attribute to see if elements are hidden [#1](https://github.com/NotNinja/europa/issues/1)
* Add command line interface [#2](https://github.com/NotNinja/europa/issues/2)
* Create unit test suite [#3](https://github.com/NotNinja/europa/issues/3)
* Rewrite code in CoffeeScript [#4](https://github.com/NotNinja/europa/issues/4)
* Add compatibility support for node.js [#5](https://github.com/NotNinja/europa/issues/5)
* Add build process [#6](https://github.com/NotNinja/europa/issues/6)
66 changes: 18 additions & 48 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,27 @@
# Contributing

Here are some guidelines that we'd like contributors to follow so that we can have a chance of
keeping things right.

## Getting Starting

* Make sure you have a [GitHub account](https://github.com/signup/free)
* Submit a ticket for your issue if one does not already exist
* Clearly describe the issue including steps to reproduce when it is a bug
* Include the earliest version that you know has the issue
* Fork the repository on GitHub
* Read the `INSTALL.md` file

## Making Changes

* Create a topic branch from where you want to base your work
* This is usually the master branch
* Only target release branches if you are certain your fix must be on that branch
* To quickly create a topic branch based on master;
`git branch fix/master/my_contribution master` then checkout the new branch with
`git checkout fix/master/my_contribution`
* Avoid working directly on the `master` branch
* Make commits of logical units
* Check for unnecessary whitespace with `git diff --check` before committing
* Make sure your commit messages are in the proper format
* Avoid updating the distributable file or annotated source code documentation
```
(#99999) Make the example in CONTRIBUTING imperative and concrete
If you have any questions about [Europa](https://github.com/NotNinja/europa) please feel free to
[raise an issue](https://github.com/NotNinja/europa/issues/new).

Please [search existing issues](https://github.com/NotNinja/europa/issues) for the same feature and/or issue before
raising a new issue. Commenting on an existing issue is usually preferred over raising duplicate issues.

Without this patch applied the example commit message in the CONTRIBUTING document is not a
concrete example. This is a problem because the contributor is left to imagine what the commit
message should look like based on a description rather than an example. This patch fixes the
problem by making the example concrete and imperative.
Please ensure that all files conform to the coding standards, using the same coding style as the rest of the code base.
All unit tests should be updated and passing as well. All of this can easily be checked via command-line:

The first line is a real life imperative statement with a ticket number from our issue tracker. The
body describes the behavior without the patch, why this is a problem, and how the patch fixes the
problem when applied.
``` bash
# install/update package dependencies
$ npm install
# run build & test suite
$ npm run ci
```
* Make sure you have added the necessary tests for your changes
* Run *all* the tests to assure nothing else was accidentally broken

## Submitting Changes
You must have at least [Node.js](https://nodejs.org) version 4 or newer and [npm](https://npmjs.com) installed version 5
or newer installed.

* Ensure you added your details to `AUTHORS.md` in the correct format
`Joe Bloggs <joe.bloggs@example.com>`
* Push your changes to a topic branch in your fork of the repository
* Submit a pull request to neocotic's repository
* Update your issue to mark that you have submitted code and are ready for it to be reviewed
* Include a link to the pull request in the issue
Feel free to make use of the `demo.html` to test your changes locally before committing.

# Additional Resources
All pull requests should be made to the `develop` branch.

* [html.md repository](https://github.com/neocotic/html.md)
* [Issue tracker](https://github.com/neocotic/html.md/issues)
* [General GitHub documentation](http://help.github.com)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests)
Don't forget to add your details to the list of [AUTHORS.md](https://github.com/NotNinja/europa/blob/master/AUTHORS.md)
if you want your contribution to be recognized by others.
50 changes: 0 additions & 50 deletions Gruntfile.coffee

This file was deleted.

Loading

0 comments on commit c9743b2

Please sign in to comment.