bevry / projectz Goto Github PK
View Code? Open in Web Editor NEWStop wasting time maintaining your project's readme and package files! Let Projectz do it for you.
License: Other
Stop wasting time maintaining your project's readme and package files! Let Projectz do it for you.
License: Other
It's just an XML file. Spec is here:
http://docs.nuget.org/docs/reference/nuspec-reference
This would be useful for Windows devs (me) who use Nuget. You can use Nuget with any type of project, but it's built into Visual Studio so typically Microsoft stack devs use it. For example, we're using it for eonarheim/Excalibur.
Not sure if they have an API
Related to this inline todo.
Is it just me, or does Literate CoffeeScript make the code quite unreadable?
https://github.com/bevry/projectz/blob/master/src/lib/projectz.litcoffee
I find it great for small and short scripts, but for big files like projectz.litcoffee, it makes it quite difficult to read since the indentation goes all over the place:
https://raw.github.com/bevry/projectz/master/src/lib/projectz.litcoffee
Thoughts?
Would be nice to be able to add custom badges like:
badges:
custom:
analytics:
text: 'Analytics'
image: 'https://ga-beacon.appspot.com/some-ga-code/some-repo/readme'
url: 'https://github.com/some-org-auth/some-repo'
tooltip: 'hello'
something like the following code put into misc badges to parse these custom badges
custom = (opts) ->
if opts == null
opts = {}
if !opts.badges.custom or !opts.name
return ''
else
results = ''
for key of opts.badges.custom
customInfo = opts.badges.custom[key]
tooltipFmtd = if customInfo.tooltip then ' "' + customInfo.tooltip + '"' else ''
results += '[![' + customInfo.text + '](' + customInfo.image + ')](' + customInfo.url + tooltipFmtd + ')'
results
I'll be happy to pull on this
After calling compile
the package.json and bower.json files are missing the newline which is needed for git and vim. Here is an example diff:
-}
+}
\ No newline at end of file
The issue points back to an issue with cson.
We need to bump cson to v2.0.0
I must have forgotten to push them to github! Oops.
We will need to either convert the rendered javascript from the npm package back to coffeescript to figure out the changes... or hope that my laptop comes back with the hdd data intact..
Miss yoooouuuuuu!
Watched your talk on web components. Was pretty awesome.
Seems now projectz 0.5.0 will now only allow two license types.
Previous versions allowed us to put our own preferred license type.
Can we keep it so that we can have custom license types in the README?
When executing compile
in a project where you have a bower file, the dependencies
and the devDevpendencies
get overwritten by the ones specified in package.json
@bergie's suggestion
Automatically build and maintain HISTORY.md.
This is a tricky one, as a commit message is not a deliverable feature/bug fix. Whether or not it actually makes sense is a question yet to be ansered. What are your thoughts?
Bring in updates from https://github.com/bevry/base and have Projectz maintain them?
<!-- EXAMPLE[./example.js] -->
will output the file in a syntax code block, and replaces require('./')
with require('the-package-name')
- useful for including example code files
<!-- CODE[./input.js] -->
will output the file in a syntax highlighted code block - useful for including code files
<!-- SOURCE[./output.md] -->
will output the file as is, no code block wrapper - useful for including markdown and HTML files
Would be cool if we could inject data properties into the readme files, something like:
<!-- #name -->
Perhaps?
The issue here is how to avoid unintended replacements.
The other issue, is who would actually use this?
Would be great to have this listed as a direct install option
Something like:
### Direct
- Install: `//wzrd.in/bundle/[email protected]`
- Use: `require('taskgroup')`
http://requirebin.com/ could also come in handy here, as it allows you to do things like
// require something
alert(JSON.stringify(require('taskgroup/package.json')))
Following #21 , we should streamline the tests.
Detect whether or not we're using DocPad and have <!-- INSTALL -->
add DocPad instructions if applicable.
Thank you for this. I love it.
I've noticed that if <!-- TITLE -->
is at the top of the file, it doesn't get replaced.
➜ mingimingi git:(master) ✗ node node_modules/projectz/bin/projectz compile
info: Initialising project
info: Initialised project
info: Loading changes
error: TypeError: undefined is not a function
at Object.exports.eval (/home/shahar/src/mingimingi/node_modules/projectz/node_modules/cson/node_modules/coffee-script/lib/coffee-script/coffee-script.js:133:47)
at CSON.parseSync (/home/shahar/src/mingimingi/node_modules/projectz/node_modules/cson/out/lib/cson.js:105:34)
at ambi (/home/shahar/src/mingimingi/node_modules/projectz/node_modules/cson/node_modules/ambi/out/lib/ambi.js:57:27)
at [object Object]._onTimeout (/home/shahar/src/mingimingi/node_modules/projectz/node_modules/cson/out/lib/cson.js:89:18)
at Timer.listOnTimeout (timers.js:133:15)
➜ mingimingi git:(master) ✗
Malformed CSON file?
{
title: "MingiMingi"
name: "mingimingi"
repo: "mightyiam/mingimingi"
description: "Another document editor for browsers."
keywords: [
"document",
"editor",
"browser"
]
author: "2014+ Shahar Or" +
" <[email protected]>" +
" (https://github.com/mightyiam)"
license: "GPLv3"
browsers: true
badges:
gittip: "mightyiam"
}
Like those from https://github.com/docpad/docpad-plugin-services
http://shields.io/ has come a long way, we should update accordingly
[npm-image]: https://img.shields.io/npm/v/serve-index.svg?style=flat
[npm-url]: https://npmjs.org/package/serve-index
[travis-image]: https://img.shields.io/travis/expressjs/serve-index.svg?style=flat
[travis-url]: https://travis-ci.org/expressjs/serve-index
[coveralls-image]: https://img.shields.io/coveralls/expressjs/serve-index.svg?style=flat
[coveralls-url]: https://coveralls.io/r/expressjs/serve-index?branch=master
[downloads-image]: https://img.shields.io/npm/dm/serve-index.svg?style=flat
[downloads-url]: https://npmjs.org/package/serve-index
[gratipay-image]: https://img.shields.io/gratipay/dougwilson.svg?style=flat
[gratipay-url]: https://www.gratipay.com/dougwilson/
After a conversation with @whit537 it seems that for the backers functionality one day we could add gittip support. So that backers who have made themselves known can be listed within the backers listings of your repo.
Depends on the following from gittip (not sure what their issue #s are):
We should abstract out our badges stuff into it's own package, so it can be shared by projects like #25
In doing so, we should merge projectz badges with those from https://github.com/docpad/docpad-plugin-services
The current infrastructure is pretty much all over the place. It's more just a proof of concept.
I'm wondering what such an architecture would look like if we rewrite it in ChainyJS.
I also wonder if this could allow plugins to extend it.
Example here
This will stop CRLF compatibility issues when using windows and keep a file format unity between cross OS development
Would be cool if one of the special keywords used in the package.json, and bower.json, etc was for version and it could either be input by the user or read from git tags.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.