Skip to content

Commit

Permalink
Merge pull request #1712 from NoRedInk/use-nix-release
Browse files Browse the repository at this point in the history
update readme nix direnv instructions & misc cleanups
  • Loading branch information
michaelglass authored Dec 4, 2024
2 parents d31e756 + d79f383 commit b55747a
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 278 deletions.
2 changes: 2 additions & 0 deletions .envrc.nix
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
use flake || use nix
# circumvent https://github.com/direnv/direnv/issues/1345
mkdir -p $TMPDIR
export PATH="$(pwd)/node_modules/.bin:$PATH"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ To get started, install nix from [nixos.org/nix](https://nixos.org/nix/).
After that's set up in your shell (just follow the instructions at the end of the installation script) you can run `nix-shell` to get a development environment with everything you need.

If you find that inconvenient, try using [`direnv`](https://direnv.net/).
Once that's set up, `echo use nix > .envrc` and then `direnv allow`.
Once that's set up, `ln -s .envrc.nix .envrc` and then `direnv allow`.
Anytime you enter the project your shell will automatically pick up the right dependencies.

If you find that `direnv` loads too slow, [there are faster loading strategies than the default in their wiki](https://github.com/direnv/direnv/wiki/Nix).
Expand Down
1 change: 0 additions & 1 deletion deprecated-modules.csv
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Nri.Ui.Highlighter.V5,upgrade to V6
Nri.Ui.Mark.V2,upgrade to V6
Nri.Ui.Pennant.V3,upgrade to V4
Nri.Ui.QuestionBox.V6,upgrade to V7
Nri.Ui.SortableTable.V4,upgrade to V5
Nri.Ui.Tabs.V6,upgrade to V9
275 changes: 0 additions & 275 deletions forbidden-imports.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,163 +35,17 @@ hint = 'Use Accessibility.Widgetd.Widget'
hint = 'Use Html.Styled'
usages = ['component-catalog-app/../src/Nri/Ui/Button/V8.elm']

[forbidden."Nri.Ui.Accordion.V1"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.Accordion.V3"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.Balloon.V1"]
hint = 'upgrade to V2'

[forbidden."Nri.Ui.Block.V1"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.Block.V2"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.Block.V3"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.Block.V4"]
hint = 'upgrade to V6'

[forbidden."Nri.Ui.Block.V5"]
hint = 'upgrade to V6'

[forbidden."Nri.Ui.BreadCrumbs.V1"]
hint = 'upgrade to V2'

[forbidden."Nri.Ui.Button.V8"]
hint = 'upgrade to V10'
usages = ['component-catalog-app/../src/Nri/Ui/SlideModal/V2.elm']

[forbidden."Nri.Ui.Carousel.V1"]
hint = 'upgrade to V2'

[forbidden."Nri.Ui.CharacterIcon.V1"]
hint = 'upgrade to V2'
usages = [
'component-catalog/../src/Nri/Ui/QuestionBox/V2.elm',
'component-catalog/../src/Nri/Ui/QuestionBox/V3.elm',
'component-catalog/../src/Nri/Ui/QuestionBox/V4.elm',
'component-catalog/../src/Nri/Ui/QuestionBox/V5.elm',
]

[forbidden."Nri.Ui.Checkbox.V5"]
hint = 'upgrade to V7'

[forbidden."Nri.Ui.Checkbox.V6"]
hint = 'upgrade to V7'

[forbidden."Nri.Ui.ClickableSvg.V1"]
hint = 'upgrade to V2'
usages = ['component-catalog-app/Examples/Tooltip.elm']

[forbidden."Nri.Ui.ClickableText.V3"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.Container.V1"]
hint = 'upgrade to V2'

[forbidden."Nri.Ui.Heading.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.Highlightable.V1"]
hint = 'upgrade to V3'
usages = [
'component-catalog/../src/Highlighter/Grouping.elm',
'component-catalog/../src/Highlighter/Internal.elm',
'component-catalog/../src/Nri/Ui/Highlighter/V2.elm',
]

[forbidden."Nri.Ui.Highlightable.V2"]
hint = 'upgrade to V3'
usages = ['component-catalog/../src/Nri/Ui/Highlighter/V3.elm']

[forbidden."Nri.Ui.Highlighter.V1"]
hint = 'upgrade to V2'

[forbidden."Nri.Ui.Highlighter.V2"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.Highlighter.V3"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.Highlighter.V4"]
hint = 'upgrade to V5'

[forbidden."Nri.Ui.Highlighter.V5"]
hint = 'upgrade to V6'

[forbidden."Nri.Ui.HighlighterToolbar.V1"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.HighlighterToolbar.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.Icon.V3"]
hint = 'upgrade to V5'
usages = ['component-catalog-app/../src/Nri/Ui/Modal/V3.elm']

[forbidden."Nri.Ui.Icon.V4"]
hint = 'upgrade to V5'

[forbidden."Nri.Ui.InputStyles.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.InputStyles.V3"]
hint = 'upgrade to V4'
usages = ['component-catalog/../src/Nri/Ui/TextArea/V4.elm']

[forbidden."Nri.Ui.Mark.V1"]
hint = 'upgrade to V2'
usages = ['component-catalog/../src/Nri/Ui/Block/V1.elm']

[forbidden."Nri.Ui.Mark.V2"]
hint = 'upgrade to V6'
usages = ['component-catalog/../src/Nri/Ui/Block/V4.elm']

[forbidden."Nri.Ui.Mark.V3"]
hint = 'upgrade to V6'

[forbidden."Nri.Ui.Mark.V4"]
hint = 'upgrade to V6'
usages = ['component-catalog/../src/Nri/Ui/Block/V5.elm']

[forbidden."Nri.Ui.Mark.V5"]
hint = 'upgrade to V6'

[forbidden."Nri.Ui.Menu.V1"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.Menu.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.Menu.V3"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.Message.V1"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.Message.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.Message.V3"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.Modal.V10"]
hint = 'upgrade to V11'
usages = ['component-catalog-app/Examples/RadioButton.elm']

[forbidden."Nri.Ui.Modal.V11"]
hint = 'upgrade to V12'

[forbidden."Nri.Ui.Modal.V3"]
hint = 'upgrade to V11'

[forbidden."Nri.Ui.Pennant.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.Pennant.V3"]
hint = 'upgrade to V4'
Expand All @@ -202,137 +56,8 @@ usages = [
'component-catalog/src/Examples/PremiumCheckbox.elm',
]

[forbidden."Nri.Ui.PremiumCheckbox.V6"]
hint = 'upgrade to V8'

[forbidden."Nri.Ui.PremiumCheckbox.V7"]
hint = 'upgrade to V8'

[forbidden."Nri.Ui.QuestionBox.V1"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.QuestionBox.V2"]
hint = 'upgrade to V5'
usages = ['component-catalog/../src/Nri/Ui/Block/V3.elm']

[forbidden."Nri.Ui.QuestionBox.V3"]
hint = 'upgrade to V5'

[forbidden."Nri.Ui.QuestionBox.V4"]
hint = 'upgrade to V5'

[forbidden."Nri.Ui.QuestionBox.V6"]
hint = 'upgrade to V7'

[forbidden."Nri.Ui.RadioButton.V1"]
hint = 'upgrade to V2'

[forbidden."Nri.Ui.RadioButton.V2"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.RadioButton.V3"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.SegmentedControl.V11"]
hint = 'upgrade to V14'

[forbidden."Nri.Ui.SegmentedControl.V12"]
hint = 'upgrade to V14'

[forbidden."Nri.Ui.SegmentedControl.V13"]
hint = 'upgrade to V14'

[forbidden."Nri.Ui.Select.V5"]
hint = 'upgrade to V8'

[forbidden."Nri.Ui.Select.V7"]
hint = 'upgrade to V8'

[forbidden."Nri.Ui.Select.V8"]
hint = 'upgrade to V9'

[forbidden."Nri.Ui.SideNav.V1"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.SideNav.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.SideNav.V3"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.SideNav.V4"]
hint = 'upgrade to V5'

[forbidden."Nri.Ui.SortableTable.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.SortableTable.V3"]
hint = 'upgrade to V4'

[forbidden."Nri.Ui.SortableTable.V4"]
hint = 'upgrade to V5'

[forbidden."Nri.Ui.Switch.V1"]
hint = 'upgrade to V2'

[forbidden."Nri.Ui.Switch.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.Table.V4"]
hint = 'upgrade to V5'

[forbidden."Nri.Ui.Table.V5"]
hint = 'upgrade to V6'

[forbidden."Nri.Ui.Table.V6"]
hint = 'upgrade to V7'

[forbidden."Nri.Ui.Tabs.V6"]
hint = 'upgrade to V9'

[forbidden."Nri.Ui.Tabs.V7"]
hint = 'upgrade to V8'

[forbidden."Nri.Ui.Tabs.V8"]
hint = 'upgrade to V9'

[forbidden."Nri.Ui.Text.V2"]
hint = 'upgrade to V5'
usages = [
'component-catalog-app/../src/Nri/Ui/Page/V3.elm',
'component-catalog-app/../src/Nri/Ui/SlideModal/V2.elm',
'component-catalog-app/Examples/DisclosureIndicator.elm',
]

[forbidden."Nri.Ui.Text.V4"]
hint = 'upgrade to V5'
usages = [
'component-catalog-app/Examples/Accordion.elm',
'component-catalog-app/Examples/Icon.elm',
'component-catalog-app/Examples/IconExamples.elm',
'component-catalog-app/Examples/Loading.elm',
'component-catalog-app/Examples/Modal.elm',
'component-catalog-app/Examples/Tooltip.elm',
]

[forbidden."Nri.Ui.Text.V5"]
hint = 'upgrade to V6'

[forbidden."Nri.Ui.TextArea.V4"]
hint = 'upgrade to V5'

[forbidden."Nri.Ui.TextInput.V6"]
hint = 'upgrade to V8'

[forbidden."Nri.Ui.TextInput.V7"]
hint = 'upgrade to V8'

[forbidden."Nri.Ui.Tooltip.V1"]
hint = 'upgrade to V3'
usages = ['component-catalog/../src/Nri/Ui/Menu/V1.elm']

[forbidden."Nri.Ui.Tooltip.V2"]
hint = 'upgrade to V3'

[forbidden."Nri.Ui.WhenFocusLeaves.V1"]
hint = 'upgrade to V2'
1 change: 0 additions & 1 deletion tests/elm-verify-examples.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@
"Nri.Ui.Select.V9",
"Nri.Ui.Shadows.V1",
"Nri.Ui.SideNav.V5",
"Nri.Ui.SortableTable.V4",
"Nri.Ui.SortableTable.V5",
"Nri.Ui.Spacing.V1",
"Nri.Ui.Sprite.V1",
Expand Down

0 comments on commit b55747a

Please sign in to comment.