Skip to content
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

docs(README): add more context to localIdentName #711

Merged
merged 1 commit into from
May 5, 2018
Merged

docs(README): add more context to localIdentName #711

merged 1 commit into from
May 5, 2018

Conversation

philipbordallo
Copy link
Contributor

@philipbordallo philipbordallo commented May 5, 2018

What kind of change does this PR introduce?
Updates README file so the localIdentName options are clearer and easier to access, added a link to it in the options, and moved it to its own section.

Did you add tests for your changes?
No, not relevant

If relevant, did you update the README?
Yes

Summary
It's currently not clear from the README what all the relevant options are for localIdentName and it should have a link in the options table as to make access to it easier.

Does this PR introduce a breaking change?
No

Other information

@jsf-clabot
Copy link

jsf-clabot commented May 5, 2018

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@michael-ciniawsky michael-ciniawsky left a comment

Choose a reason for hiding this comment

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

👍 Thx, only two small nits :)

README.md Outdated
@@ -339,6 +304,44 @@ To import from multiple modules use multiple `composes:` rules.
}
```

### `localIdentName`

You can configure the generated ident with the `localIdentName` query parameter (default `[hash:base64]`). See [loader-utils's documentation](https://github.com/webpack/loader-utils#interpolatename) for more information on options.
Copy link
Member

Choose a reason for hiding this comment

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

- (default `[hash:base64]`)

Already in the options table :)

README.md Outdated
}
```

> :information_source: For prerendering with extract-text-webpack-plugin you should use `css-loader/locals` instead of `style-loader!css-loader` **in the prerendering bundle**. It doesn't embed CSS but only exports the identifier mappings.
Copy link
Member

Choose a reason for hiding this comment

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

:information_source: => ℹ️ ('rendered')

@michael-ciniawsky michael-ciniawsky changed the title Give more context to localIdentName in the README docs(README): add more context to localIdentName May 5, 2018
@michael-ciniawsky michael-ciniawsky added this to the 0.28.12 milestone May 5, 2018
@codecov
Copy link

codecov bot commented May 5, 2018

Codecov Report

Merging #711 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #711   +/-   ##
=======================================
  Coverage   98.43%   98.43%           
=======================================
  Files          11       11           
  Lines         384      384           
  Branches       90       90           
=======================================
  Hits          378      378           
  Misses          6        6

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 1c51265...cc29d1f. Read the comment docs.

@philipbordallo
Copy link
Contributor Author

philipbordallo commented May 5, 2018

@michael-ciniawsky I cleaned up the two things you mentioned.

Copy link
Member

@michael-ciniawsky michael-ciniawsky left a comment

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants