61dfb94 · Idris-dev · git.iko.soy

git.iko.soy/Idris-dev

on master help sign in

Extend iPKG files to include metadata.

61dfb94Jan de Muijnck-Hughes10 years ago

CHANGELOG.md+17−1

compare with master

unifiedsplit

@@ -80,9 +80,25 @@

80* Added `Data.List.Views` with views on `List` and their covering functions.

81* Added `Data.Nat.Views` with views on `Nat` and their covering functions.

82* Added `Data.Primitives.Views` with views on various primitive types and their covering functions.

83−* Added `System.Concurrency.Sessions` for simple management of conversations

83+* Added `System.Concurrency.Sessions` for simple management of conversations

84 between processes

86+## iPKG Updates

87+

88+* Taking cues from cabal, the `iPKG` format has been extended to

89+ include more package metadata information. The following fields

90+ have been added:

91+

92+ + `brief`: Brief description of the package.

93+ + `version`: Version string to associate with the package.

94+ + `readme`: Location of the README file.

95+ + `license`: Description of the licensing information.

96+ + `author`: Author information.

97+ + `maintainer`: Maintainer information.

98+ + `homepage`: Website associated with the package.

99+ + `sourcepage`: Location of the DVCS where the source can be found.

100+

101+

86## Miscellaneous updates

102## Miscellaneous updates

103

88* The Idris man page is now installed as part of the cabal/stack build process.

104* The Idris man page is now installed as part of the cabal/stack build process.

docs/reference/packages.rst+29

@@ -31,6 +31,35 @@ written as follows::

31Other examples of package files can be found in the ``libs`` directory

32of the main Idris repository, and in `third-party libraries <https://github.com/idris-lang/Idris-dev/wiki/Libraries>`_.

34+Metadata

35+--------

36+

37+From Idris `v0.12` the `iPKG` format supports additional metadata

38+associated with the package.

39+The added fields are:

40+

41++ ``brief = "<text>"``, a string literal containing a brief description

42+ of the package.

43+

44++ ``version = <text>``, a version string to associate with the package.

45+

46++ ``readme = <file>``, location of the README file.

47+

48++ ``license = <text>``, a string description of the licensing

49+ information.

50+

51++ ``author = <text>``, the author information.

52+

53++ ``maintainer = <text>``, Maintainer information.

54+

55++ ``homepage = <url>``, the website associated with the package.

56+

57++ ``sourceloc = <url>``, the location of the DVCS where the source

58+ can be found.

59+

60++ ``bugtracker = <url>``, the location of the project's bug tracker.

61+

62+

34Common Fields

63Common Fields

35-------------

64-------------

src/Pkg/PParser.hs+102−12

@@ -29,18 +29,33 @@ import Util.System

29type PParser = StateT PkgDesc IdrisInnerParser

31data PkgDesc = PkgDesc {

32− pkgname :: String

32+ pkgname :: String -- ^ Name associated with a package.

33+ , pkgbrief :: Maybe String -- ^ Brief description of the package.

34+ , pkgversion :: Maybe String -- ^ Version string to associate with the package.

35+ , pkgreadme :: Maybe String -- ^ Location of the README file.

36+ , pkglicense :: Maybe String -- ^ Description of the licensing information.

37+ , pkgauthor :: Maybe String -- ^ Author information.

38+ , pkgmaintainer :: Maybe String -- ^ Maintainer information.

39+ , pkghomepage :: Maybe String -- ^ Website associated with the package.

40+ , pkgsourceloc :: Maybe String -- ^ Location of the source files.

41+ , pkgbugtracker :: Maybe String -- ^ Location of the project's bug tracker.

33− , libdeps :: [String]

42+ , libdeps :: [String] -- ^ External dependencies.

34− , objs :: [String]

43+ , objs :: [String] -- ^ Object files required by the package.

35− , makefile :: Maybe String

44+ , makefile :: Maybe String -- ^ Makefile used to build external code. Used as part of the FFI process.

36− , idris_opts :: [Opt]

45+ , idris_opts :: [Opt] -- ^ List of options to give the compiler.

37− , sourcedir :: String

46+ , sourcedir :: String -- ^ Source directory for Idris files.

38− , modules :: [Name]

47+ , modules :: [Name] -- ^ Modules provided by the package.

39− , idris_main :: Name

48+ , idris_main :: Name -- ^ If an executable in which module can the Main namespace and function be found.

40− , execout :: Maybe String

49+ , execout :: Maybe String -- ^ What to call the executable.

41− , idris_tests :: [Name]

50+ , idris_tests :: [Name] -- ^ Lists of tests to execute against the package.

42 } deriving (Show)

51 } deriving (Show)

53+-- | Default settings for package descriptions.

54+defaultPkg :: PkgDesc

55+defaultPkg = PkgDesc "" Nothing Nothing Nothing Nothing

56+ Nothing Nothing Nothing Nothing

57+ Nothing [] [] Nothing [] "" [] (sUN "") Nothing []

58+

44instance HasLastTokenSpan PParser where

59instance HasLastTokenSpan PParser where

45 getLastTokenSpan = return Nothing

60 getLastTokenSpan = return Nothing

@@ -51,8 +66,6 @@ instance TokenParsing PParser where

51#endif

66#endif

52 someSpace = many (simpleWhiteSpace <|> singleLineComment <|> multiLineComment) *> pure ()

67 someSpace = many (simpleWhiteSpace <|> singleLineComment <|> multiLineComment) *> pure ()

54−defaultPkg :: PkgDesc

55−defaultPkg = PkgDesc "" [] [] Nothing [] "" [] (sUN "") Nothing []

57parseDesc :: FilePath -> IO PkgDesc

70parseDesc :: FilePath -> IO PkgDesc

58parseDesc fp = do

71parseDesc fp = do

@@ -121,41 +134,118 @@ pClause = do reserved "executable"; lchar '=';

121 exec <- filename

134 exec <- filename

122 st <- get

135 st <- get

123 put (st { execout = Just exec })

136 put (st { execout = Just exec })

137+

124 <|> do reserved "main"; lchar '=';

138 <|> do reserved "main"; lchar '=';

125 main <- fst <$> iName []

139 main <- fst <$> iName []

126 st <- get

140 st <- get

127 put (st { idris_main = main })

141 put (st { idris_main = main })

142+

128 <|> do reserved "sourcedir"; lchar '=';

143 <|> do reserved "sourcedir"; lchar '=';

129 src <- fst <$> identifier

144 src <- fst <$> identifier

130 st <- get

145 st <- get

131 put (st { sourcedir = src })

146 put (st { sourcedir = src })

147+

132 <|> do reserved "opts"; lchar '=';

148 <|> do reserved "opts"; lchar '=';

133 opts <- stringLiteral

149 opts <- stringLiteral

134 st <- get

150 st <- get

135 let args = pureArgParser (words opts)

151 let args = pureArgParser (words opts)

136 put (st { idris_opts = args ++ idris_opts st })

152 put (st { idris_opts = args ++ idris_opts st })

153+

137 <|> do reserved "pkgs"; lchar '=';

154 <|> do reserved "pkgs"; lchar '=';

138 ps <- sepBy1 (fst <$> identifier) (lchar ',')

155 ps <- sepBy1 (fst <$> identifier) (lchar ',')

139 st <- get

156 st <- get

140 let pkgs = pureArgParser $ concatMap (\x -> ["-p", x]) ps

157 let pkgs = pureArgParser $ concatMap (\x -> ["-p", x]) ps

141 put (st {idris_opts = pkgs ++ idris_opts st})

158 put (st {idris_opts = pkgs ++ idris_opts st})

159+

142 <|> do reserved "modules"; lchar '=';

160 <|> do reserved "modules"; lchar '=';

143 ms <- sepBy1 (fst <$> iName []) (lchar ',')

161 ms <- sepBy1 (fst <$> iName []) (lchar ',')

144 st <- get

162 st <- get

145 put (st { modules = modules st ++ ms })

163 put (st { modules = modules st ++ ms })

164+

146 <|> do reserved "libs"; lchar '=';

165 <|> do reserved "libs"; lchar '=';

147 ls <- sepBy1 (fst <$> identifier) (lchar ',')

166 ls <- sepBy1 (fst <$> identifier) (lchar ',')

148 st <- get

167 st <- get

149 put (st { libdeps = libdeps st ++ ls })

168 put (st { libdeps = libdeps st ++ ls })

169+

150 <|> do reserved "objs"; lchar '=';

170 <|> do reserved "objs"; lchar '=';

151 ls <- sepBy1 (fst <$> identifier) (lchar ',')

171 ls <- sepBy1 (fst <$> identifier) (lchar ',')

152 st <- get

172 st <- get

153 put (st { objs = libdeps st ++ ls })

173 put (st { objs = libdeps st ++ ls })

174+

154 <|> do reserved "makefile"; lchar '=';

175 <|> do reserved "makefile"; lchar '=';

155 mk <- fst <$> iName []

176 mk <- fst <$> iName []

156 st <- get

177 st <- get

157 put (st { makefile = Just (show mk) })

178 put (st { makefile = Just (show mk) })

179+

158 <|> do reserved "tests"; lchar '=';

180 <|> do reserved "tests"; lchar '=';

159 ts <- sepBy1 (fst <$> iName []) (lchar ',')

181 ts <- sepBy1 (fst <$> iName []) (lchar ',')

160 st <- get

182 st <- get

161 put st { idris_tests = idris_tests st ++ ts }

183 put st { idris_tests = idris_tests st ++ ts }

184+

185+ <|> do reserved "version"

186+ lchar '='

187+ vStr <- many (satisfy (not . isEol))

188+ eol

189+ someSpace

190+ st <- get

191+ put st {pkgversion = Just vStr}

192+

193+ <|> do reserved "readme"

194+ lchar '='

195+ rme <- many (satisfy (not . isEol))

196+ eol

197+ someSpace

198+ st <- get

199+ put (st { pkgreadme = Just rme })

200+

201+ <|> do reserved "license"

202+ lchar '='

203+ lStr <- many (satisfy (not . isEol))

204+ eol

205+ st <- get

206+ put st {pkglicense = Just lStr}

207+

208+ <|> do reserved "homepage"

209+ lchar '='

210+ www <- many (satisfy (not . isEol))

211+ eol

212+ someSpace

213+ st <- get

214+ put st {pkghomepage = Just www}

215+

216+ <|> do reserved "sourceloc"

217+ lchar '='

218+ srcpage <- many (satisfy (not . isEol))

219+ eol

220+ someSpace

221+ st <- get

222+ put st {pkgsourceloc = Just srcpage}

223+

224+ <|> do reserved "bugtracker"

225+ lchar '='

226+ src <- many (satisfy (not . isEol))

227+ eol

228+ someSpace

229+ st <- get

230+ put st {pkgbugtracker = Just src}

231+

232+ <|> do reserved "brief"

233+ lchar '='

234+ brief <- stringLiteral

235+ st <- get

236+ someSpace

237+ put st {pkgbrief = Just brief}

238+

239+ <|> do reserved "author"; lchar '=';

240+ author <- many (satisfy (not . isEol))

241+ eol

242+ someSpace

243+ st <- get

244+ put st {pkgauthor = Just author}

245+

246+ <|> do reserved "maintainer"; lchar '=';

247+ maintainer <- many (satisfy (not . isEol))

248+ eol

249+ someSpace

250+ st <- get

251+ put st {pkgmaintainer = Just maintainer}

test/pkg001/test-pkg.ipkg+10

@@ -5,3 +5,13 @@ pkgs = effects

5opts = "--warnpartial --warnreach --nocolour --quiet --consolewidth 80"

7modules = Main

9+author = Anne Author

10+maintainer = Anne Maintainer

11+license = BSD3 but see LICENSE for more information

12+brief = "This is a test package."

13+readme = README.md

14+version = 1234

15+homepage = http://www.idris-lang.org

16+sourceloc = http://ww.github.com/idris-lang/Idris-Dev

17+bugtracker = http://ww.github.com/idris-lang/Idris-Dev/issues