From 66e728b0158779a8975012b852698d73fe291660 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Georges=20Dup=C3=A9ron?= Date: Thu, 13 Jul 2017 18:53:22 +0200 Subject: [PATCH] Package skeleton --- .gitignore | 7 ++++++ .travis.yml | 37 +++++++++++++++++++++++++++++++ LICENSE-more.md | 24 ++++++++++++++++++++ LICENSE.txt | 24 ++++++++++++++++++++ README.md | 11 +++++++++ info.rkt | 10 +++++++++ main.rkt | 14 ++++++++++++ scribblings/travis-skeleton.scrbl | 31 ++++++++++++++++++++++++++ 8 files changed, 158 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE-more.md create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 info.rkt create mode 100644 main.rkt create mode 100644 scribblings/travis-skeleton.scrbl diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a9892bf --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +*~ +\#* +.\#* +.DS_Store +compiled/ +/doc/ +/coverage/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..dcd3e90 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,37 @@ +language: c +sudo: false + +env: + global: + # RACKET_DIR is an argument to install-racket.sh + - RACKET_DIR=~/racket + - PATH="$RACKET_DIR/bin:$PATH" + matrix: + # RACKET_VERSION is an argument to install-racket.sh + - RACKET_VERSION=6.0 COV=false + - RACKET_VERSION=6.1 COV=false + - RACKET_VERSION=6.1.1 COV=false + - RACKET_VERSION=6.2 COV=false + - RACKET_VERSION=6.3 COV=false + - RACKET_VERSION=6.4 COV=true + - RACKET_VERSION=6.5 COV=true + - RACKET_VERSION=6.6 COV=true + - RACKET_VERSION=6.7 COV=true + - RACKET_VERSION=6.8 COV=true + - RACKET_VERSION=RELEASE COV=true + - RACKET_VERSION=HEAD COV=true + +before_install: +- curl -L https://raw.githubusercontent.com/greghendershott/travis-racket/master/install-racket.sh | bash +- if $COV; then raco pkg install --deps search-auto doc-coverage cover cover-codecov; fi # or cover-coveralls + +install: +- raco pkg install --deps search-auto -j 2 + +script: +- raco test -x -p "$(basename "$TRAVIS_BUILD_DIR")" +- if $COV; then raco setup --check-pkg-deps --no-zo --no-launcher --no-install --no-post-install --no-docs --pkgs "$(basename "$TRAVIS_BUILD_DIR")"; fi +- if $COV; then raco doc-coverage "$(basename "$TRAVIS_BUILD_DIR")"; fi +- if $COV; then raco cover -s main -s test -s doc -f codecov -f html -d ~/coverage . || true; fi +# TODO: add an option to cover to run the "outer" module too, not just the submodules. +# TODO: deploy the coverage info. \ No newline at end of file diff --git a/LICENSE-more.md b/LICENSE-more.md new file mode 100644 index 0000000..6045316 --- /dev/null +++ b/LICENSE-more.md @@ -0,0 +1,24 @@ +$$$PKG_NAME$$$ +Copyright (c) 2016-2017 Georges Dupéron + + + +This package is in distributed under the Creative Commons CC0 license +https://creativecommons.org/publicdomain/zero/1.0/, as specified by +the LICENSE.txt file. + + + +The CC0 license is equivalent to a dedication to the Public Domain +in most countries, but is also effective in countries which do not +recognize explicit dedications to the Public Domain. + + + +In order to avoid any potential licensing issues, this package is explicitly +distributed under the Creative Commons CC0 license +https://creativecommons.org/publicdomain/zero/1.0/, or under the GNU Lesser +General Public License (LGPL) https://opensource.org/licenses/LGPL-3.0, or +under the Apache License Version 2.0 +https://opensource.org/licenses/Apache-2.0, or under the MIT license +https://opensource.org/licenses/MIT, at your option. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..6045316 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,24 @@ +$$$PKG_NAME$$$ +Copyright (c) 2016-2017 Georges Dupéron + + + +This package is in distributed under the Creative Commons CC0 license +https://creativecommons.org/publicdomain/zero/1.0/, as specified by +the LICENSE.txt file. + + + +The CC0 license is equivalent to a dedication to the Public Domain +in most countries, but is also effective in countries which do not +recognize explicit dedications to the Public Domain. + + + +In order to avoid any potential licensing issues, this package is explicitly +distributed under the Creative Commons CC0 license +https://creativecommons.org/publicdomain/zero/1.0/, or under the GNU Lesser +General Public License (LGPL) https://opensource.org/licenses/LGPL-3.0, or +under the Apache License Version 2.0 +https://opensource.org/licenses/Apache-2.0, or under the MIT license +https://opensource.org/licenses/MIT, at your option. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a73e816 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +[![Build Status,](https://img.shields.io/travis/jsmaniac/$$$PKG_NAME$$$/master.svg)](https://travis-ci.org/jsmaniac/$$$PKG_NAME$$$) +[![Coverage Status,](https://img.shields.io/codecov/c/github/jsmaniac/$$$PKG_NAME$$$/master.svg)](https://codecov.io/gh/jsmaniac/$$$PKG_NAME$$$) +[![Build Stats,](https://img.shields.io/badge/build-stats-blue.svg)](http://jsmaniac.github.io/travis-stats/#jsmaniac/$$$PKG_NAME$$$) +[![Online Documentation,](https://img.shields.io/badge/docs-online-blue.svg)](http://docs.racket-lang.org/$$$PKG_NAME$$$/) +[![Maintained as of 2017,](https://img.shields.io/maintenance/yes/2017.svg)](https://github.com/jsmaniac/$$$PKG_NAME$$$/issues) +[![License: CC0 v1.0.](https://img.shields.io/badge/license-CC0-blue.svg)](https://creativecommons.org/publicdomain/zero/1.0/) + +$$$PKG_NAME$$$ +============== + +A Racket package. \ No newline at end of file diff --git a/info.rkt b/info.rkt new file mode 100644 index 0000000..7757adf --- /dev/null +++ b/info.rkt @@ -0,0 +1,10 @@ +#lang info +(define collection "$$$PKG_NAME$$$") +(define deps '("base" ;; ("base" "6.4") + "rackunit-lib")) +(define build-deps '("scribble-lib" + "racket-doc")) +(define scribblings '(("scribblings/$$$PKG_NAME$$$.scrbl" ()))) +(define pkg-desc "") +(define version "0.0") +(define pkg-authors '("Georges Dupéron")) diff --git a/main.rkt b/main.rkt new file mode 100644 index 0000000..a68874f --- /dev/null +++ b/main.rkt @@ -0,0 +1,14 @@ +#lang hyper-literate #:no-auto-require(dotlambda/unhygienic . typed/racket/base) + +@(require (for-label typed/racket/base)) + +@section{Conclusion} + +@chunk[<*> + (provide + ;; description + #;id) + + (require (for-syntax racket/base)) + + #;(define id …)] diff --git a/scribblings/travis-skeleton.scrbl b/scribblings/travis-skeleton.scrbl new file mode 100644 index 0000000..b10ff71 --- /dev/null +++ b/scribblings/travis-skeleton.scrbl @@ -0,0 +1,31 @@ +#lang scribble/manual +@require[@for-label[$$$PKG_NAME$$$ + racket/base]] + +@title{$$$PKG_NAME$$$} +@author[@author+email["Georges Dupéron" "georges.duperon@gmail.com"]] + +@defmodule[$$$PKG_NAME$$$] + +There is no documentation for this package yet. + +@(define-syntax (show-ids _stx) + (syntax-case stx () + [(_ b) + (boolean? (syntax-e #'b)) + (let-values ([(vars stx-vars) (module->exports $$$PKG_NAME$$$)]) + #`(itemlist + #,(for*/list ([phase+ids (in-list (if (syntax-e #'b) vars stx-vars))] + [phase (in-value (car phase+ids))] + [id (in-list (cdr phase+ids))]) + #`(item (racketit #,id) + "at phase" + #,(number->string phase)))))])) + +The following variables are provided: + +@(show-ids #t) + +The following syntaxes are provided: + +@(show-ids #f) \ No newline at end of file