jedi4ever / markdown2confluence Goto Github PK

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

  spec.license = 'MIT'
  # or
  spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

Given the following code:

```json
{
  "Region": "ap-southeast-2",
  "DaysToKeep": 60
}

It is rendering as:

json
{
  "Region": "ap-southeast-2",
  "DaysToKeep": 60
}

Using a code block

```bash
# some bash script
```

is converted to

{code}bash
# some bash script
{code}

while it should become (according to atlassian docs)

{code:language=bash}
# some bash script
{code}

{Host} should be escaped to \{Host\} else confluence is not happy.

Hi. Would you be willing to add a license file to this repo?

Thanks!

Nested list should convert to --, ---, etc.

In markdown, you can use newlines to do manual word wrapping (handy with M-q in emacs) and it does not consider them a new paragraph. Ie., Markdown considers double-newlines to be paragraph delimiters. See http://daringfireball.net/projects/markdown/syntax#p.

However, Confluence interprets single newlines into <br>s and markdown2confluence passes them right through, meaning that your paragraphs display in Confluence peppered with <br>s.

Instead, markdown2confluence It should strip out single newlines.

As an example, this markdown:

1. One
2. Two
3. Three

...gets converted to:

*  One
*  Two
*  Three

Given the following markdown source:

`role__packer__base_spec.rb`

I am getting generated Confluence that appears as:

role_packer_base_spec.rb

Does anyone have any idea what I would need to change in the code to fix this? If so, happy to send in a merge request.

Consider the following markdown:

> foo
> bar

This should produce something similar to this output:

{quote}
foo
bar
{quote}

But instead, it produces:

bq.   foo
bar

This means that "foo" would be quoted where "bar" wouldn't be.

original text

Hi, all

交接清单 demo。

-  日常需求

--  eg. 商业部批量导入数据，需求方：七七
--  eg. 达人数据报表，需求方：小平子
-  容易出问题的地方

--  eg. 内容审核后台经常 Pass 失败，需求方：凳子
--  eg. 上传图片有时候会报错 500，需求方：产品
-  维护的 Job

--  eg. 星座爬取脚本

--  运行在 s14
--  {{/jobs/crawl.py >> /tmp/  crawl_astro.log 2>&1}}
--  频率：一周一次
--  需求方：SM

convert to

Hi, all

交接清单 demo。

-  日常需求

--  eg. 商业部批量导入数据，需求方：七七
--  eg. 达人数据报表，需求方：小平子
-  容易出问题的地方

--  eg. 内容审核后台经常 Pass 失败，需求方：凳子
--  eg. 上传图片有时候会报错 500，需求方：产品
-  维护的 Job

--  eg. 星座爬取脚本

--  运行在 s14
--  {{/jobs/crawl.py >> /tmp/  crawl_astro.log 2>&1}}
--  频率：一周一次
--  需求方：SM

The output wiki is error, which

-  日常需求

--  eg. 商业部批量导入数据，需求方：七七
--  eg. 达人数据报表，需求方：小平子

should be

-  日常需求
--  eg. 商业部批量导入数据，需求方：七七
--  eg. 达人数据报表，需求方：小平子

For example,

{{console.log("hello world");}}

instead of

{code}
console.log("hello world");
{code}

The latter is what I expected to happen.

###### is not properly converted to h6.

I don't know whether you expect it to work under this environment, but I couldn't get it to. Using the gem install approach I struggled with a series of missing libraries, installing each one as I went, until I hit this:

========================================================================
error: can't open patch '/cygdrive/c/Users/martin.mccullion/.gem/ruby/2.3.0/gems/nokogiri-1.8.0/patches/libxml2/0001-Fix-comparison-with-root-node-in-xmlXPathCmpNodes.patch': No such file or directory
========================================================================
*** extconf.rb failed ***
Could not create Makefile due to some reason, probably lack of necessary
libraries and/or headers.  Check the mkmf.log file for more details.  You may
need configuration options.

Even thought that file exists. So I tried using the GitHub approach. That seemed to work, but when I tried to run the installed command, I got this:

$ bundle exec bin/markdown2confluence
Bundler could not find compatible versions for gem "nokogiri":
  In Gemfile:
    markdown2confluence was resolved to 0.0.4, which depends on
      nokogiri

Could not find gem 'nokogiri', which is required by gem 'markdown2confluence', in any of the sources.