refactor(templates/README): standardize #50

michael-ciniawsky · 2017-04-24T15:30:07Z

No description provided.

michael-ciniawsky · 2017-04-24T15:30:40Z

Please webpack-defaults release after this :)

codecov · 2017-04-24T15:33:09Z

Codecov Report

❗ No coverage uploaded for pull request base (next@194be38). Click here to learn what that means.
The diff coverage is 0%.

@@         Coverage Diff          @@
##             next   #50   +/-   ##
====================================
  Coverage        ?    0%           
====================================
  Files           ?     9           
  Lines           ?    56           
  Branches        ?     2           
====================================
  Hits            ?     0           
  Misses          ?    56           
  Partials        ?     0

Impacted Files	Coverage Δ
src/tasks/babel.js	`0% <ø> (ø)`
src/tasks/package.js	`0% <ø> (ø)`
src/tasks/templates.js	`0% <ø> (ø)`
src/tasks/readme.js	`0% <0%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 194be38...c3d1183. Read the comment docs.

sapegin · 2017-04-24T15:34:12Z

templates/README.template

-          </br>
-          Name
-        </a>
+        <img width="150" height="150"


Now images are not linked.

Yep wrapping the image is the better solution 👌, I revert it :)

As a part of the JS Foundation, we have to clearly define to consumers who the maintainers are.

We should probably default this to the org-maintainers ( not the admin group ) and not the bot as the bot breaks the above rule.

For any upgrade where the repo has assigned maintainers, they can update accordingly.

@d3viant0ne This was my first intention aswell, but I wasn't sure if everyone would agree with that, so I used to non-personal bot account, will update

https://github.com/orgs/webpack-contrib/teams/org-maintainers correct?

sapegin · 2017-04-24T15:38:46Z

templates/README.template

 [![coverage][cover]][cover-url]
 [![chat][chat]][chat-url]

 <div align="center">
  <!-- replace with accurate logo e.g from https://worldvectorlogo.com/ -->
-  <img width="200" height="200" src="https://cdn.worldvectorlogo.com/logos/javascript.svg">
+  <img width="140" height="140" src="https://cdn.worldvectorlogo.com/logos/javascript.svg">


Why project icon is smaller than webpack icon? ;-) I’d make hspace the same, otherwise they won’t be centered correctly.

The placeholder 'JS Logo' is to fat imho 😛

I’d make hspace the same, otherwise they won’t be centered correctly

? 🙃

Now it will render like this:

[img] [hspace][img][hspace]

This would be better:

[hspace][img][hspace] [hspace][img][hspace]

@michael-ciniawsky - Just use this one

<img width="185" height="185" src="https://cdn.worldvectorlogo.com/logos/nodejs-icon.svg"> <a href="https://webpack.js.org/"> <img width="200" height="200" src="https://webpack.js.org/assets/icon-square-big.svg"> </a>

sapegin · 2017-04-24T15:45:21Z

templates/README.template

  </a>
-  <h1>${package}</h1>
-  <p>${description}</p>
+  <h1>${name}</h1>


There’s no name variable. Have you tested it? You need to remove the current Readme to see how it works.

😱 I thought this was just a dummy placeholder sry..., obviously nope 😛, kk

michael-ciniawsky · 2017-04-24T18:17:41Z

lib/tasks/readme.js

.apply({
        title: pkg.get('name')
                .split('-')
                .filter((name) => name !== 'webpack' ? name : '')
                .map((name) => name.replace(name.charAt(0), name.charAt(0).toUpperCase()))
                .join(' '),
        name: pkg.get('name')
                .replace(/(-loader|-webpack-plugin)$/, '')
                .split('-')
                .map((name) => name.replace(name.charAt(0), name.charAt(0).toUpperCase()))
                .join(''),
        package: pkg.get('name'),
        description: pkg.get('description') || 'DESCRIPTION',
      })

`title`

name-loader => Name Loader
name-webpack-plugin => Name Plugin

`name`

name-loader => Name
name-webpack-plugin => Name

?

sapegin · 2017-04-24T18:42:25Z

I like the idea, but I’d not remove ”webpack‘ ;-) So it’s just _.startCase.

michael-ciniawsky · 2017-04-24T18:53:56Z

//  Helpers
const title = (x) => x.split('-')
  .filter((name) => name !== 'webpack' ? name : '')
  .map((name) => name.replace(name.charAt(0), name.charAt(0).toUpperCase()))
  .join(' ')

const name = (x) => x.replace(/(-loader|-webpack-plugin)$/, '')
  .split('-')
  .map((name) => name.replace(name.charAt(0), name.charAt(0).toUpperCase()))
  .join('')

// 'Test' :)

console.log(name('some-loader'))
console.log(title('some-loader'))

// => 'Some Loader'
// => 'Some'

console.log(name('some-webpack-plugin'))
console.log(title('some-webpack-plugin'))

// => 'Some Plugin'
// => 'Some'

console.log(title('some-awesome-webpack-plugin'))
console.log(name('some-awesome-webpack-plugin'))

// => 'Some Awesome Plugin'
// => 'SomeAwesome'

<h1>${title}</h1>

{
   test: /\.ext$/,
   use: [ { loader: `${name.toLowerCase()}-loader`, options: {} } ]
}

plugins: [
  new `${name}Plugin(options)`
]

Some Loader

{
   test: /\.ext$/,
   use: [ { loader: 'some-loader', options: {} }]
}

Some Plugin

plugins: [
  new SomePlugin(options)
]

michael-ciniawsky · 2017-04-24T19:00:49Z

-webpack could also stay of course, but I personally see -loader && -webpack-plugin as ${package} appendix 😛

sapegin · 2017-04-24T19:04:00Z

They make it easy to understand what it is. Babel is not the same as Babel Loader and HTML is not the same as HTML Webpack Plugin (and I have no idea what’s HTML Plugin ;–)

michael-ciniawsky · 2017-04-24T19:08:20Z

Fair point :) I leave -webpack @bebraw @d3viant0ne any objections on this [in general]?

sapegin · 2017-04-24T19:11:32Z

You can automate it ;-)

michael-ciniawsky · 2017-04-26T21:31:27Z

@sapegin done 😊

sapegin · 2017-04-27T07:50:39Z

src/tasks/readme.js

-        description: pkg.get('description') || 'DESCRIPTION',
-      })
-      .save();
+    const getCase = name => name.replace(


Why don’t you like Lodash? 👻

I don't use lodash, therefore I didn't know _.startCase existed 😛 I interpreted your earlier comment as 'create helper fn' for casing :D. I'll take a look at _.startCase later today 👻

sapegin · 2017-06-06T19:41:46Z

Are we going to finish this?

michael-ciniawsky · 2017-06-07T09:39:58Z

Yep I intend to, but I merge on github a while ago and then it's seems I made a mistake during a rebase, so maybe I need to reopen this :) We take a look into later 😛

joshwiens · 2017-06-09T05:44:21Z

templates/README.template

          </br>
-          Name
+          Michael Ciniawsky
        </a>


Should add Alexander here and something else of note, when we first started applying this general readme template ...

1.) Tobias specifically asked that there be no more than 5 listed, ever.
2.) Asked not to be listed under the maintainers section.

1.) Tobias specifically asked that there be no more than 5 listed, ever.

With Alexander added we are full then :): Will do...

2.) Asked not to be listed under the maintainers section.

You mean Tobias here ?

As a maintainer listed in the readme of any repo under contrib.

michael-ciniawsky requested review from sapegin, bebraw and joshwiens April 24, 2017 15:30

michael-ciniawsky added the type: Documentation label Apr 24, 2017

michael-ciniawsky self-assigned this Apr 24, 2017

sapegin requested changes Apr 24, 2017

View reviewed changes

sapegin reviewed Apr 27, 2017

View reviewed changes

joshwiens force-pushed the master branch from bb46bb2 to 0e3a114 Compare April 29, 2017 18:24

joshwiens reviewed Jun 9, 2017

View reviewed changes

michael-ciniawsky changed the base branch from master to next December 16, 2017 10:56

michael-ciniawsky added pr_action: Review semver: Patch status: Pending type: Refactor and removed type: Documentation labels Dec 16, 2017

michael-ciniawsky added this to the 2.0.0 milestone Dec 16, 2017

michael-ciniawsky changed the title ~~style(templates): standardize README template~~ refactor(templates/README): standardize Dec 16, 2017

michael-ciniawsky requested a review from sapegin December 16, 2017 11:20

michael-ciniawsky requested review from alexander-akait and joshwiens December 16, 2017 11:20

joshwiens approved these changes Dec 18, 2017

View reviewed changes

refactor(templates/README): standardize

c3d1183

joshwiens merged commit 7ac432a into webpack-contrib:next Dec 19, 2017

michael-ciniawsky deleted the templates branch December 20, 2017 11:14

michael-ciniawsky added status: Approved and removed pr_action: Review status: Pending labels Dec 20, 2017

michael-ciniawsky removed this from the 3.0.0 milestone Aug 17, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(templates/README): standardize #50

refactor(templates/README): standardize #50

michael-ciniawsky commented Apr 24, 2017 •

edited

Loading

michael-ciniawsky commented Apr 24, 2017

codecov bot commented Apr 24, 2017 •

edited

Loading

sapegin Apr 24, 2017

michael-ciniawsky Apr 24, 2017

joshwiens Apr 24, 2017

michael-ciniawsky Apr 24, 2017

michael-ciniawsky Apr 24, 2017

sapegin Apr 24, 2017

michael-ciniawsky Apr 24, 2017

sapegin Apr 24, 2017

joshwiens Dec 18, 2017

michael-ciniawsky Dec 18, 2017

sapegin Apr 24, 2017

michael-ciniawsky Apr 24, 2017

michael-ciniawsky commented Apr 24, 2017 •

edited

Loading

sapegin commented Apr 24, 2017

michael-ciniawsky commented Apr 24, 2017 •

edited

Loading

michael-ciniawsky commented Apr 24, 2017

sapegin commented Apr 24, 2017

michael-ciniawsky commented Apr 24, 2017 •

edited

Loading

sapegin commented Apr 24, 2017

michael-ciniawsky commented Apr 26, 2017

sapegin Apr 27, 2017

michael-ciniawsky Apr 27, 2017

sapegin commented Jun 6, 2017

michael-ciniawsky commented Jun 7, 2017

joshwiens Jun 9, 2017

michael-ciniawsky Jun 9, 2017

joshwiens Jun 9, 2017

refactor(templates/README): standardize #50

refactor(templates/README): standardize #50

Conversation

michael-ciniawsky commented Apr 24, 2017 • edited Loading

michael-ciniawsky commented Apr 24, 2017

codecov bot commented Apr 24, 2017 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michael-ciniawsky commented Apr 24, 2017 • edited Loading

title

name

sapegin commented Apr 24, 2017

michael-ciniawsky commented Apr 24, 2017 • edited Loading

Some Loader

Some Plugin

michael-ciniawsky commented Apr 24, 2017

sapegin commented Apr 24, 2017

michael-ciniawsky commented Apr 24, 2017 • edited Loading

sapegin commented Apr 24, 2017

michael-ciniawsky commented Apr 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sapegin commented Jun 6, 2017

michael-ciniawsky commented Jun 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michael-ciniawsky commented Apr 24, 2017 •

edited

Loading

codecov bot commented Apr 24, 2017 •

edited

Loading

michael-ciniawsky commented Apr 24, 2017 •

edited

Loading

`title`

`name`

michael-ciniawsky commented Apr 24, 2017 •

edited

Loading

michael-ciniawsky commented Apr 24, 2017 •

edited

Loading