Skip to content

Commit

Permalink
[CLOSES #368] Webpack issuefixed with v0.0.14 of @misk/components. @m…
Browse files Browse the repository at this point in the history
…isk/ documentation updates (#369)

Why
---
- Fix #368 issue in `@misk/components`
- Make NPM package documentation more uniform in capitalization of package names
- Fix broken Releasing link in documentation
  • Loading branch information
adrw authored Aug 15, 2018
1 parent f788fc8 commit 036db68
Show file tree
Hide file tree
Showing 16 changed files with 54 additions and 73 deletions.
3 changes: 2 additions & 1 deletion misk/web/@misk/RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ Example Release Flow
- Update all minor versions of `@Misk/` packages in `package.json`
- Publish new version 0.0.7 for `@Misk/Dev`
- Update `package.json` in `@Misk/Common` and `@Misk/Components` to bump `@Misk/Dev` to version 0.0.7
- Run ``
- Reinstall node modules and test that they work with the new `@Misk/Dev` package version `rm -rf node_modules/; yarn install`
- Publish new version 0.0.13 for `@Misk/Common`
- Update `package.json` in `@Misk/Components` to bump `@Misk/Common` to version 0.0.13
- Reinstall node modules and test that they work with the new `@Misk/Dev` and `@Misk/Common` package version `rm -rf node_modules/; yarn install`
- Publish new version 0.0.3 for `@Misk/Components`
- Update all related tabs to the newest `@Misk/` packages
8 changes: 3 additions & 5 deletions misk/web/@misk/common/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
@misk/common
Misk Common
---
![](https://raw.githubusercontent.com/square/misk/master/misk.png)
`@misk/common` provides shared libraries, externals, and styles between `@misk` modules.
This package provides shared libraries, externals, and styles across Misk tab repos.

Getting Started
---
- Install `@misk/common`

```bash
$ yarn add @misk/common
```
Expand Down Expand Up @@ -119,5 +117,5 @@ Webpack Configs
- `webpack.vendor.config.js`: Exports common vendors library file
- `webpack.basetab.config.js`: Base config used for each tab
[Releasing](../RELEASING.md)
[Releasing](https://github.com/square/misk/blob/master/misk/web/%40misk/RELEASING.md)
---
11 changes: 5 additions & 6 deletions misk/web/@misk/components/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
@Misk/Components
Misk Components
---
![](https://raw.githubusercontent.com/square/misk/master/misk.png)
`@Misk/Components` provides shared, styled React components between Misk tab repos.
This package provides shared, styled React components across Misk tab repos.

Getting Started
---
- Install `@Misk/Components`

```bash
$ yarn add @Misk/Components
$ yarn add @misk/components
```

Components
---
- NoMatchComponent: very basic component for route 404s
- PathDebugComponent: outputs values passed in by props for `hash`, `pathname`, and `search` in React-Router instance

[Releasing](../RELEASING.md)
[Releasing](https://github.com/square/misk/blob/master/misk/web/%40misk/RELEASING.md)
---
2 changes: 1 addition & 1 deletion misk/web/@misk/components/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@misk/components",
"version": "0.0.13",
"version": "0.0.14",
"description": "Microservice Kontainer Common Components",
"author": "Square/Misk Authors (https://github.com/square/misk/graphs/contributors)",
"main": "lib/components.js",
Expand Down
2 changes: 1 addition & 1 deletion misk/web/@misk/components/src/NoMatchComponent.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import * as React from "react"
import * as React from "React"

export interface INoMatchProps {
prefix: string
Expand Down
2 changes: 1 addition & 1 deletion misk/web/@misk/components/src/PathDebugComponent.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import * as React from "react"
import * as React from "React"

export interface IPathDebugProps {
hash: string,
Expand Down
56 changes: 18 additions & 38 deletions misk/web/@misk/components/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# yarn lockfile v1


"@blueprintjs/core@^3.3.0":
"@blueprintjs/core@^3.0.1":
version "3.3.0"
resolved "https://registry.yarnpkg.com/@blueprintjs/core/-/core-3.3.0.tgz#6fc5c7d811d1c0693c0c3d7a472549e171c455db"
dependencies:
Expand Down Expand Up @@ -41,30 +41,26 @@
reflect-metadata "^0.1.12"
tslib "^1.8.1"

"@misk/common@^0.0.11":
version "0.0.11"
resolved "https://registry.yarnpkg.com/@misk/common/-/common-0.0.11.tgz#92e046eff0ce247d6a5efc9873d9059de21ca5d4"
"@misk/common@^0.0.8":
version "0.0.8"
resolved "https://registry.yarnpkg.com/@misk/common/-/common-0.0.8.tgz#c24ab7d5c74c8319e6716bab85c97bf5c785677b"
dependencies:
"@blueprintjs/core" "^3.3.0"
"@blueprintjs/core" "^3.0.1"
"@blueprintjs/icons" "^3.0.0"
axios "^0.18.0"
connected-react-router "^4.4.1"
dayjs "^1.7.5"
connected-react-router "^4.3.0"
history "^4.7.2"
immutable "^3.8.2"
react "^16.4.2"
react-dom "^16.4.2"
react "^16.4.1"
react-dom "^16.4.1"
react-helmet "^5.2.0"
react-hot-loader "^4.3.4"
react-hot-loader "^4.3.3"
react-redux "^5.0.7"
react-router "^4.3.1"
react-router-dom "^4.3.1"
react-router-redux "^5.0.0-alpha.9"
react-transition-group "^2.4.0"
react-transition-group "^2.2.1"
redux "^4.0.0"
redux-saga "^0.16.0"
skeleton-css "^2.0.4"
styled-components "^3.4.2"
styled-components "^3.3.3"

"@misk/dev@^0.0.8":
version "0.0.8"
Expand Down Expand Up @@ -1071,7 +1067,7 @@ connect-history-api-fallback@^1.3.0:
version "1.5.0"
resolved "https://registry.yarnpkg.com/connect-history-api-fallback/-/connect-history-api-fallback-1.5.0.tgz#b06873934bc5e344fef611a196a6faae0aee015a"

connected-react-router@^4.4.1:
connected-react-router@^4.3.0:
version "4.4.1"
resolved "https://registry.yarnpkg.com/connected-react-router/-/connected-react-router-4.4.1.tgz#352ad5340ca3d296e7ebac14adcf789eb8a20e0c"
dependencies:
Expand Down Expand Up @@ -1314,10 +1310,6 @@ date-now@^0.1.4:
version "0.1.4"
resolved "https://npm.vip.global.square/date-now/-/date-now-0.1.4.tgz#eaf439fd4d4848ad74e5cc7dbef200672b9e345b"

dayjs@^1.7.5:
version "1.7.5"
resolved "https://registry.yarnpkg.com/dayjs/-/dayjs-1.7.5.tgz#14715cb565d1f8cb556a8531cb14bf1fc33067cc"

debug@2.6.9, debug@^2.1.2, debug@^2.2.0, debug@^2.3.3, debug@^2.6.6, debug@^2.6.8:
version "2.6.9"
resolved "https://npm.vip.global.square/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f"
Expand Down Expand Up @@ -3925,7 +3917,7 @@ rc@^1.1.7:
minimist "^1.2.0"
strip-json-comments "~2.0.1"

react-dom@^16.4.2:
react-dom@^16.4.1:
version "16.4.2"
resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-16.4.2.tgz#4afed569689f2c561d2b8da0b819669c38a0bda4"
dependencies:
Expand All @@ -3943,7 +3935,7 @@ react-helmet@^5.2.0:
prop-types "^15.5.4"
react-side-effect "^1.1.0"

react-hot-loader@^4.3.4:
react-hot-loader@^4.3.3:
version "4.3.4"
resolved "https://registry.yarnpkg.com/react-hot-loader/-/react-hot-loader-4.3.4.tgz#4f9bdd55bb20d77a6ae8931fa1c187e5f0ce6279"
dependencies:
Expand Down Expand Up @@ -3995,15 +3987,7 @@ react-router-dom@^4.3.1:
react-router "^4.3.1"
warning "^4.0.1"

react-router-redux@^5.0.0-alpha.9:
version "5.0.0-alpha.9"
resolved "https://registry.yarnpkg.com/react-router-redux/-/react-router-redux-5.0.0-alpha.9.tgz#825431516e0e6f1fd93b8807f6bd595e23ec3d10"
dependencies:
history "^4.7.2"
prop-types "^15.6.0"
react-router "^4.2.0"

react-router@^4.2.0, react-router@^4.3.1:
react-router@^4.3.1:
version "4.3.1"
resolved "https://npm.vip.global.square/react-router/-/react-router-4.3.1.tgz#aada4aef14c809cb2e686b05cee4742234506c4e"
dependencies:
Expand All @@ -4022,7 +4006,7 @@ react-side-effect@^1.1.0:
exenv "^1.2.1"
shallowequal "^1.0.1"

react-transition-group@^2.2.1, react-transition-group@^2.4.0:
react-transition-group@^2.2.1:
version "2.4.0"
resolved "https://registry.yarnpkg.com/react-transition-group/-/react-transition-group-2.4.0.tgz#1d9391fabfd82e016f26fabd1eec329dbd922b5a"
dependencies:
Expand All @@ -4031,7 +4015,7 @@ react-transition-group@^2.2.1, react-transition-group@^2.4.0:
prop-types "^15.6.2"
react-lifecycles-compat "^3.0.4"

react@^16.4.2:
react@^16.4.1:
version "16.4.2"
resolved "https://registry.yarnpkg.com/react/-/react-16.4.2.tgz#2cd90154e3a9d9dd8da2991149fdca3c260e129f"
dependencies:
Expand Down Expand Up @@ -4092,10 +4076,6 @@ redent@^1.0.0:
indent-string "^2.1.0"
strip-indent "^1.0.1"

redux-saga@^0.16.0:
version "0.16.0"
resolved "https://registry.yarnpkg.com/redux-saga/-/redux-saga-0.16.0.tgz#0a231db0a1489301dd980f6f2f88d8ced418f724"

"redux@>= 3.7.2", redux@^4.0.0:
version "4.0.0"
resolved "https://npm.vip.global.square/redux/-/redux-4.0.0.tgz#aa698a92b729315d22b34a0553d7e6533555cc03"
Expand Down Expand Up @@ -4788,7 +4768,7 @@ style-loader@^0.22.1:
loader-utils "^1.1.0"
schema-utils "^0.4.5"

styled-components@^3.4.2:
styled-components@^3.3.3:
version "3.4.2"
resolved "https://registry.yarnpkg.com/styled-components/-/styled-components-3.4.2.tgz#8f518419932327e47fe9144824e3184b3e2da95d"
dependencies:
Expand Down
10 changes: 4 additions & 6 deletions misk/web/@misk/dev/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
@Misk/Dev
Misk Dev
---
![](https://raw.githubusercontent.com/square/misk/master/misk.png)
`@Misk/Dev` provides shared devDependencies used to provide a common development environment across Misk tab repos.
This package provides shared devDependencies used to provide a common development environment across Misk tab repos.

Getting Started
---
- Install `@Misk/Dev`

```bash
$ yarn add @Misk/Dev
$ yarn add @misk/dev
```

Included Libraries
Expand Down Expand Up @@ -50,5 +48,5 @@ Included Libraries
"webpack-dev-server": "^3.1.5"
```

[Releasing](../RELEASING.md)
[Releasing](https://github.com/square/misk/blob/master/misk/web/%40misk/RELEASING.md)
---
2 changes: 1 addition & 1 deletion misk/web/tabs/config/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"dependencies": {
"@misk/common": "^0.0.12",
"@misk/components": "^0.0.13"
"@misk/components": "^0.0.14"
},
"devDependencies": {
"@misk/dev": "^0.0.8"
Expand Down
4 changes: 2 additions & 2 deletions misk/web/tabs/config/src/containers/TabContainer.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { PathDebugComponent } from "@misk/components"
import { NoMatchComponent, PathDebugComponent } from "@misk/components"
import * as React from "react"
import { connect } from "react-redux"
import styled from "styled-components"
Expand Down Expand Up @@ -28,7 +28,7 @@ class TabContainer extends React.Component<ITabProps, {children : any}> {
<div id={this.props.slug}/>
{this.props.children}
<PathDebugComponent hash={this.props.hash} pathname={this.props.pathname} search={this.props.search}/>
{/* <NoMatchComponent prefix="Config"/> */}
<NoMatchComponent prefix="Config"/>
<h1>Config</h1>
</Container>
)
Expand Down
5 changes: 5 additions & 0 deletions misk/web/tabs/config/webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ module.exports = {
exclude: /node_modules/,
loaders: 'awesome-typescript-loader'
},
{
enforce: 'pre',
test: /\.js$/,
loader: 'source-map-loader'
},
{
test: /\.scss$/,
loader: 'style-loader!css-loader!sass-loader'
Expand Down
6 changes: 3 additions & 3 deletions misk/web/tabs/config/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@
skeleton-css "^2.0.4"
styled-components "^3.4.2"

"@misk/components@^0.0.13":
version "0.0.13"
resolved "https://registry.yarnpkg.com/@misk/components/-/components-0.0.13.tgz#737f4a988b6f4cbaca48732ddeba6b8cafa5716d"
"@misk/components@^0.0.14":
version "0.0.14"
resolved "https://registry.yarnpkg.com/@misk/components/-/components-0.0.14.tgz#faca255fdc65c1ff9be9d3471afdc785e56ce1eb"
dependencies:
"@misk/common" "^0.0.12"

Expand Down
2 changes: 1 addition & 1 deletion misk/web/tabs/dashboard/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"dependencies": {
"@misk/common": "^0.0.12",
"@misk/components": "^0.0.13"
"@misk/components": "^0.0.14"
},
"devDependencies": {
"@misk/dev": "^0.0.8"
Expand Down
6 changes: 3 additions & 3 deletions misk/web/tabs/dashboard/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@
skeleton-css "^2.0.4"
styled-components "^3.4.2"

"@misk/components@^0.0.13":
version "0.0.13"
resolved "https://registry.yarnpkg.com/@misk/components/-/components-0.0.13.tgz#737f4a988b6f4cbaca48732ddeba6b8cafa5716d"
"@misk/components@^0.0.14":
version "0.0.14"
resolved "https://registry.yarnpkg.com/@misk/components/-/components-0.0.14.tgz#faca255fdc65c1ff9be9d3471afdc785e56ce1eb"
dependencies:
"@misk/common" "^0.0.12"

Expand Down
2 changes: 1 addition & 1 deletion misk/web/tabs/loader/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"dependencies": {
"@misk/common": "^0.0.12",
"@misk/components": "^0.0.13"
"@misk/components": "^0.0.14"
},
"devDependencies": {
"@misk/dev": "^0.0.8"
Expand Down
6 changes: 3 additions & 3 deletions misk/web/tabs/loader/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@
skeleton-css "^2.0.4"
styled-components "^3.4.2"

"@misk/components@^0.0.13":
version "0.0.13"
resolved "https://registry.yarnpkg.com/@misk/components/-/components-0.0.13.tgz#737f4a988b6f4cbaca48732ddeba6b8cafa5716d"
"@misk/components@^0.0.14":
version "0.0.14"
resolved "https://registry.yarnpkg.com/@misk/components/-/components-0.0.14.tgz#faca255fdc65c1ff9be9d3471afdc785e56ce1eb"
dependencies:
"@misk/common" "^0.0.12"

Expand Down

0 comments on commit 036db68

Please sign in to comment.