bingo 0.1.0 → 0.3.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+# MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,41 +1,35 @@
-# bingo
+<h1 align="center">Bingo</h1>
 
-Test function calls.
+<p align="center">Composable, testable, type-safe templates. 💝</p>
 
-## Getting Started
-This module is not on npm yet but you can download it here on github.
+<p align="center">
+	<a href="https://github.com/JoshuaKGoldberg/create/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
+	<a href="https://codecov.io/gh/JoshuaKGoldberg/create" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/create?label=%F0%9F%A7%AA%20coverage" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/create/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
+	<a href="http://npmjs.com/package/create"><img alt="📦 npm version" src="https://img.shields.io/npm/v/create?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
+	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
+</p>
 
-## Examples
+👉 See **[create.bingo](https://create.bingo)**.
 
-```javascript
-// Require the module.
-var bingo = require('bingo');
+Bingo is a new scaffolding engine for describing repository templates.
+It's like a modern version of [Yeoman](https://yeoman.io), but:
 
-// Bingo that object.
-var someObject = bingo(someObject);
+- **Composable**: Individual blocks in your templates can be mix-and-matched together
+- **Testable**: Each layer of your templates can be individually unit or end-to-end tested
+- **Type-Safe**: Fully typed from the ground up, including [Zod](https://zod.dev)-based options schemas
 
-// Get info about the function.
-console.log(someObject.someFunction.didExecute() === false); // true
-console.log(someObject.someFunction.timesExecuted()); // 0
+Bingo also provides scaffolding to turn templates into a repository generator akin to a `create-next-app` or `create-typescript-app`.
 
-// Call some function.
-someObject.someFunction();
+👉 See **[create.bingo](https://create.bingo)**.
 
-// Get info about the execution of the function.
-console.log(someObject.someFunction.didExecute() === true); // true
-console.log(someObject.someFunction.timesExecuted()); // 1
-```
+## Status
 
-## Contributing
-Yes yes, please, contribute. What else do you want to know about an execution of a function ?
+Bingo is early stage.
+It runs well but its APIs are still in flux.
+Please try it out and report any issues on GitHub!
+🙏
 
-Lint and test your code using [grunt](https://github.com/cowboy/grunt).
+> 💙 This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app).
 
-## Release History
- - 0.1.0 (2012-09-14) First version
-
-## License
-
-Copyright (c) 2012 Djorje Lukic
-
-Licensed under the [MIT license](http://rumpl.mit-license.org/).
+> Special thanks to [@rumpl](https://github.com/rumpl) for granting use of the `bingo` package name. 🙏

package/package.json

@@ -1,35 +1,6 @@
 {
   "name": "bingo",
-  "description": "Test function calls.",
-  "version": "0.1.0",
-  "homepage": "https://github.com/rumpl/bingo",
-  "author": {
-    "name": "Djorje Lukic",
-    "email": "lukic.djordje@gmail.com"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/rumpl/bingo.git"
-  },
-  "bugs": {
-    "url": "https://github.com/rumpl/bingo/issues"
-  },
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "https://github.com/rumpl/bingo/blob/master/LICENSE-MIT"
-    }
-  ],
-  "main": "lib/bingo",
-  "engines": {
-    "node": "~0.6.15"
-  },
-  "scripts": {
-    "test": "grunt test"
-  },
-  "dependencies": {},
-  "devDependencies": {
-    "grunt": "~0.3.9"
-  },
-  "keywords": []
-}
+  "version": "0.3.0",
+  "description": "Composable, testable, type-safe templates. 💝",
+  "license": "MIT"
+}

package/.npmignore

@@ -1 +0,0 @@
-/node_modules/

package/LICENSE-MIT

@@ -1,22 +0,0 @@
-Copyright (c) 2012 Djorje Lukic
-
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.

package/grunt.js

@@ -1,39 +0,0 @@
-module.exports = function(grunt) {
-
-  // Project configuration.
-  grunt.initConfig({
-    pkg: '<json:package.json>',
-    test: {
-      files: ['test/**/*.js']
-    },
-    lint: {
-      files: ['grunt.js', 'lib/**/*.js', 'test/**/*.js']
-    },
-    watch: {
-      files: '<config:lint.files>',
-      tasks: 'default'
-    },
-    jshint: {
-      options: {
-        curly: true,
-        eqeqeq: true,
-        immed: true,
-        latedef: true,
-        newcap: true,
-        noarg: true,
-        sub: true,
-        undef: true,
-        boss: true,
-        eqnull: true,
-        node: true
-      },
-      globals: {
-        exports: true
-      }
-    }
-  });
-
-  // Default task.
-  grunt.registerTask('default', 'lint test');
-
-};

package/lib/bingo.js

@@ -1,44 +0,0 @@
-/*
- * bingo
- * https://github.com/rumpl/bingo
- *
- * Copyright (c) 2012 Djorje Lukic
- * Licensed under the MIT license.
- */
-
-function bingo(func, obj) {
-  "use strict";
-  var newF = function() {
-    newF._didExecute = true;
-    newF._timesExecuted++;
-
-    func.apply(obj, arguments);
-  };
-
-  newF._didExecute = false;
-  newF._timesExecuted = 0;
-
-  newF.didExecute = function () {
-    return newF._didExecute;
-  };
-
-  newF.timesExecuted = function() {
-    return newF._timesExecuted;
-  };
-
-  return newF;
-}
-
-module.exports = function(obj) {
-  "use strict";
-
-  for (var o in obj) {
-    if (typeof obj[o] !== 'function') {
-      continue;
-    }
-
-    obj[o] = bingo(obj[o], obj);
-  }
-
-  return obj;
-};

package/test/bingo_test.js

@@ -1,63 +0,0 @@
-/*
- * bingo
- * https://github.com/rumpl/bingo
- *
- * Copyright (c) 2012 Djorje Lukic
- * Licensed under the MIT license.
- */
- 
-var bingo = require('../lib/bingo.js');
-
-exports.bingo = {
-  setUp: function(done) {
-    done();
-  },
-  'Works with objects created with new': function(test) {
-    "use strict";
-    var Test = function() {};
-    Test.prototype.test = function() {};
-    Test.prototype.test2 = function() {};
-
-    var t = new Test(); 
-
-    t = bingo(t);
-
-    test.equal(t.test.didExecute(), false);
-    test.equal(t.test.timesExecuted(), 0);
-
-    t.test();
-
-    test.equal(t.test.didExecute(), true);
-    test.equal(t.test.timesExecuted(), 1);
-    test.equal(t.test2.didExecute(), false);
-
-    test.done();
-  },
-  'Works with other objects': function(test) {
-    "use strict";
-    var t = { 
-      a: function() {
-        console.log('a');
-      },
-      b: function() { 
-      }
-    };
-    
-    t = bingo(t);
-
-    test.equal(t.b.didExecute(), false);
-    t.b();
-    test.equal(t.b.didExecute(), true);
-    test.equal(t.b.timesExecuted(), 1);
-    
-    for (var i = 0; i < 10; i++) {
-      t.b();
-    }
-    
-    test.equal(t.b.timesExecuted(), 11);
-    
-    test.equal(t.a.didExecute(), false);
-
-    test.done();
-  }
-};