Skip to content

Commit c5134fd

Browse files
danielrollsdanielrolls
committed
Initial commit
0 parents  commit c5134fd

File tree

9 files changed

+431
-0
lines changed

9 files changed

+431
-0
lines changed

‎COPYRIGHT

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Copyright (c) 2023 Daniel Rolls
2+
All rights reserved

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎app/Main.hs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module Main where
2+
3+
import Lib.Shellify (options, runtm)
4+
import System.Environment (getArgs)
5+
import Data.Text (pack)
6+
7+
main :: IO ()
8+
main = getArgs >>= runtm . options . map pack

‎flake.lock

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎flake.nix

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
description = "shellify";
3+
4+
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
5+
6+
outputs = { self, nixpkgs }:
7+
8+
let pkgs = nixpkgs.legacyPackages.x86_64-linux;
9+
in {
10+
11+
packages.x86_64-linux.default = (pkgs.haskell.lib.overrideCabal (
12+
pkgs.haskellPackages.developPackage {
13+
root = ./.;
14+
}
15+
) {
16+
enableSeparateDataOutput = false;
17+
}).overrideAttrs (old: {
18+
installPhase = old.installPhase + ''
19+
ln -s $out/bin/shellify $out/bin/nix-shellify
20+
'';
21+
});
22+
};
23+
}

‎shellify.cabal

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
cabal-version: 3.0
2+
name: shellify
3+
version: 0.1.0.0
4+
5+
author: Daniel Rolls
6+
maintainer: [email protected]
7+
license: Apache-2.0
8+
license-files: LICENSE
9+
copyright: (c) 2023 Daniel Rolls
10+
11+
category: Packaging
12+
extra-source-files: CHANGELOG.md
13+
data-files: templates/*.j2
14+
15+
common deps
16+
default-language: GHC2021
17+
build-depends:
18+
base ^>=4.16.4.0,
19+
text >=1.2.3.2 && <2.1
20+
21+
library
22+
import: deps
23+
exposed-modules:
24+
Lib.Shellify
25+
Paths_shellify
26+
hs-source-dirs: src
27+
autogen-modules:
28+
Paths_shellify
29+
default-extensions:
30+
OverloadedStrings
31+
build-depends:
32+
parsec >=3.1.14.0 && <3.2,
33+
ginger >=0.10.0 && <0.11,
34+
mtl >=2.2.2 && < 2.3,
35+
unordered-containers >=0.2.14.0 && <0.3,
36+
directory >=1.3.6 && <1.4
37+
38+
executable shellify
39+
import: deps
40+
main-is: Main.hs
41+
build-depends:
42+
shellify >=0
43+
hs-source-dirs: app
44+
45+
test-suite haskelltest-test
46+
import: deps
47+
type: exitcode-stdio-1.0
48+
main-is: Spec.hs
49+
hs-source-dirs: test
50+
other-modules:
51+
Paths_shellify
52+
default-extensions:
53+
OverloadedStrings
54+
ghc-options: -threaded -rtsopts -with-rtsopts=-N
55+
build-depends:
56+
shellify >=0,
57+
hspec >=2.7.1 && <2.11,
58+
parsec >=3.1.14.0 && <3.2,
59+
parsec-numbers >=0.1.0 && <0.2
60+

‎src/Lib/Shellify.hs

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{-# LANGUAGE LambdaCase #-}
2+
module Lib.Shellify (Options(Options), Packages, options, runtm) where
3+
4+
import Prelude hiding (concat, readFile, writeFile)
5+
import Text.ParserCombinators.Parsec (GenParser, many, many1, oneOf, char, parse, anyChar)
6+
import Data.Text (pack, unpack, Text(), isPrefixOf, concat)
7+
import Data.List (elemIndex, findIndex)
8+
import Control.Applicative ((<|>))
9+
import Text.Ginger hiding (length)
10+
import qualified Data.HashMap.Strict as HashMap
11+
import System.IO (openFile, hGetContents, hPutStrLn, hPutStr, stderr)
12+
import System.IO.Error (tryIOError)
13+
import System.Exit (exitFailure)
14+
import Data.Maybe (fromMaybe)
15+
import Control.Monad.Identity (join)
16+
import Paths_shellify (getDataFileName)
17+
import Data.Text.IO (readFile, writeFile)
18+
import System.Directory (doesPathExist)
19+
20+
type Packages = [ Text ]
21+
newtype Options = Options Packages deriving (Eq, Show)
22+
23+
options :: [Text] -> Options
24+
options = Options . options'
25+
26+
options' wds =
27+
let packagesSwitchPos = elemIndex "-p" wds
28+
<|> elemIndex "--packages" wds
29+
firstSwitchPosInfollowingArg = join . fmap (findIndex ("-" `isPrefixOf`)
30+
. (`drop` wds)
31+
. (+1)
32+
)
33+
$ packagesSwitchPos
34+
trailingArgsToTake = fromMaybe (length wds)
35+
firstSwitchPosInfollowingArg
36+
in maybe []
37+
(\i -> drop (i+1) (take (i+1+trailingArgsToTake) wds)
38+
<> options' (drop (i+1+trailingArgsToTake) wds)
39+
)
40+
packagesSwitchPos
41+
42+
runtm :: Options -> IO ()
43+
runtm (Options packages) =
44+
do getDataFileName "templates/shellify.nix.j2"
45+
>>= parseGingerFile loadFileMay
46+
>>= either handleParseError
47+
(createShellFile . easyRender context)
48+
where pkgsStr = ("[" <>) . (<> " ]") . concat . fmap (" pkgs." <>) $ packages
49+
context = HashMap.fromList [ ("build_inputs" :: Text, pkgsStr) ]
50+
handleParseError err = print err >> exitFailure
51+
loadFileMay fn =
52+
tryIOError (loadFile fn) >>=
53+
(\case
54+
Right contents -> return (Just contents)
55+
Left _ -> return Nothing)
56+
where
57+
loadFile fn' = unpack <$> readFile fn'
58+
59+
createShellFile :: Text -> IO ()
60+
createShellFile expectedContents = do
61+
exist <- doesPathExist "shell.nix"
62+
if not exist then do
63+
hPutStrLn stderr "shell.nix does not exist. Creating one"
64+
writeFile "shell.nix" expectedContents
65+
else do
66+
fileContents <- readFile "shell.nix"
67+
if fileContents == expectedContents then
68+
hPutStrLn stderr "The existing shell.nix is good already"
69+
else
70+
hPutStrLn stderr "A shell.nix exists already. Delete it or move it and try again"

0 commit comments

Comments
 (0)