+ {{ content }}
+
+
+
+Open Source Society University
++ Path to a free self-taught education in Computer Science! +
+ +
+
+When attempting to enroll in such a course:
+- Click the blue "Enroll" or "Enroll Now" button.
+- A pop-up will appear.
+- **Do not click** "Start Free Trial", unless you do want to pay.
+- Find the text that says "Audit this course" at the bottom.
+- Click **Audit**.
+
+
+
+### Is it necessary to purchase the Verified Upgrade for edX courses?
+
+If you just want to watch the videos, it is never necessary for any edX course on our curriculum. Note that a number of edX courses only allow students to audit a course for the estimated number of weeks it takes to complete. Students should not begin a course until they are prepared to focus and complete the course.
+
+### What are the alt links?
+
+Sometimes a course is on multiple platforms that are reasonably similar in quality so we have an alt or two linked in case the main one isn't being offered at the time or you prefer the other one. Both are just as good, go with whichever you prefer or whichever is available when you want to take the course.
+
+### Why doesn't the curriculum cover/ignore topic X?
+
+You can read more about our curricular guidelines and the qualifications of the guidelines' authors [here](CURRICULAR_GUIDELINES.md). If you find a topic that is required by our guidelines and is not included in the curriculum, we should make a change! Read more about [contributing to a change](CONTRIBUTING.md).
+
+### Why is the curriculum missing some pre-requisites?
+
+The curriculum assumes two things:
+- You are reasonably fluent in English.
+- You have gotten through a standard high school curriculum that included physics and pre-calculus.
+
+Without these assumptions, the curriculum would be out of control with trying to fill in your knowledge gaps.
+For those who want to study math pre-requisites, read more [here](#how-can-i-review-the-math-prerequisites)
+
+Of course, if you find that the curriculum is missing a pre-requisite for a course that isn't part of a normal high school curriculum, please let us know!
+
+### Why require experience with a sizable project before the Software Engineering courses?
+Software engineering tries to solve the problem of dealing with large programs. Building a sizable program before taking the SE courses will help you understand what SE is trying to solve. We recommend the Jack-to-VM-code compiler project from the nand2tetris course because it's the first project in the curriculum that is complex enough to see value in an SE course. That said, any sizable project will do and can come from outside of the OSSU curriculum. The idea is that you've done some large enough project where the pieces started to feel unmanageable. This experience will expose pain points and lead to a better understanding of SE.
+
+### How can I find a course on a particular subject?
+After completing Core CS, learners are ready to pursue computer science
+topics of their own interest. How can one find a course on a given topic?
+For MOOCs an excellent resource is [Class Central](https://www.classcentral.com/).
+For materials from university courses that are online (but not organized)
+into a MOOC, [awesome-courses](https://github.com/prakhar1989/awesome-courses) and
+[cs-video-courses](https://github.com/Developer-Y/cs-video-courses)
+are good resources. For textbooks, [Goodreads](https://www.goodreads.com/genres/computer-science)
+is a great platform for reader ratings and reviews.
+For learning a particular programming language or framework,
+[see this question](#what-is-a-good-course-to-learn-a-particular-language).
diff --git a/HELP.md b/HELP.md
new file mode 100644
index 000000000..f45250e1f
--- /dev/null
+++ b/HELP.md
@@ -0,0 +1,9 @@
+# Getting help
+## Check the FAQ!
+Please check our [Frequently Asked Questions](FAQ.md) to see if your question has been addressed.
+## Ask in the chat room
+[](https://discord.gg/5pUhfpX) Join the OSSU [Discord server](https://discord.gg/5pUhfpX)! Discord is an online chat service, similar to Slack or IRC where you can chat with other students and get help.
+### Specific problems
+If you need help successfully completing the content of a course or are having general technical difficulties, first reach out to the resources provided by the course (e.g. the course forum on Coursera, edX, etc). If you need additional help after that, post in Discord. **In your post, mention what steps you have already taken to try and solve the problem**.
+### General problems
+If you have general problems with the program not specific to any course, such as preferring textbook-style learning over MOOCs, Discord is a good place to reach out to people who may have great suggestions. You might form a working group that makes the next improvement to OSSU CS! Read more about contributing [here](CONTRIBUTING.md).
diff --git a/computer-science/01-introduction-to-cs-and-programming-mit/src/node_modules/prompt/node_modules/utile/node_modules/ncp/LICENSE.md b/LICENSE
similarity index 85%
rename from computer-science/01-introduction-to-cs-and-programming-mit/src/node_modules/prompt/node_modules/utile/node_modules/ncp/LICENSE.md
rename to LICENSE
index e2b9b4135..7c561549d 100644
--- a/computer-science/01-introduction-to-cs-and-programming-mit/src/node_modules/prompt/node_modules/utile/node_modules/ncp/LICENSE.md
+++ b/LICENSE
@@ -1,6 +1,6 @@
-# MIT License
+The MIT License (MIT)
-###Copyright (C) 2011 by Charlie McConnell
+Copyright (c) 2015-2023 Open Source Society University
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index 48bff3f38..e29f6660a 100644
--- a/README.md
+++ b/README.md
@@ -1,150 +1,457 @@
-
-
-## References
-
-- [MIT Open Courseware](http://ocw.mit.edu/courses/#electrical-engineering-and-computer-science)
-- [Google - Guide for Technical Development](https://www.google.com/about/careers/students/guide-to-technical-development.html)
-- [Coursera](https://www.coursera.org/)
-- [How can I prepare myself to be a software engineer?](http://qr.ae/fMbg8)
-
-## Topics
-
-- [Computer Science](#computer-science)
-- [Software Testing](#software-testing)
-- [Math](#math)
-- [Operating Systems](#operating-systems)
-- [Networks](#networks)
-- [Databases](#databases)
-- [Cryptography](#cryptography)
-- [Compilers](#compilers)
-- [Artificial Intelligence](#artificial-intelligence)
-- [Machine Learning](#machine-learning)
-- [Natural Language Processing](#natural-language-processing)
-- [Robotics](#robotics)
-- [Graphs](#graphs)
-- [Data Mining](#data-mining)
-- [Parallel Programming](#parallel-programming)
-- [Programming Languages](#programming-languages)
-- [Others](#others)
-
-### Computer Science
-
-1. **[Introduction to Computer Science and Programming](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-00sc-introduction-to-computer-science-and-programming-spring-2011/) ✍ - [⎙](/computer-science/01-introduction-to-cs-and-programming-mit)**
-1. [Computer Science 101 - Stanford](https://lagunita.stanford.edu/courses/Engineering/CS101/Summer2014/about) / [Other files](http://web.stanford.edu/class/cs101/) - [⎙]()
-1. [Systematic Program Design - Part 1: The Core Method](https://www.edx.org/course/systematic-program-design-part-1-core-ubcx-spd1x#!)
-1. [Systematic Program Design - Part 2: Arbitrary Sized Data](https://www.edx.org/course/systematic-program-design-part-2-ubcx-spd2x)
-1. [Systematic Program Design - Part 3: Arbitrary Sized Data](https://www.edx.org/course/systematic-program-design-part-3-ubcx-spd3x)
-1. [Fundamentals of Computing](https://www.coursera.org/specialization/fundamentalscomputing2/37/certificate)
- 1. [An Introduction to Interactive Programming in Python (Part 1)](https://www.coursera.org/course/interactivepython1) - [⎙](/computer-science/)
- 1. [An Introduction to Interactive Programming in Python (Part 2)](https://www.coursera.org/course/interactivepython2) - [⎙](/computer-science/)
- 1. [Principles of Computing (Part 1)](https://www.coursera.org/course/principlescomputing1) - [⎙](/computer-science/)
- 1. [Principles of Computing (Part 2)](https://www.coursera.org/course/principlescomputing2) - [⎙](/computer-science/)
- 1. [Algorithmic Thinking (Part 1)](https://www.coursera.org/course/algorithmicthink1) - [⎙](/computer-science/)
- 1. [Algorithmic Thinking (Part 2)](https://www.coursera.org/course/algorithmicthink2) - [⎙](/computer-science/)
-1. [Structure and Interpretation of Computer Programs](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-001-structure-and-interpretation-of-computer-programs-spring-2005/) - [⎙]()
-1. [Elements of Software Construction](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-005-elements-of-software-construction-fall-2011/) - [⎙]()
-1. [Introduction to Algorithms](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-006-introduction-to-algorithms-fall-2011/) - [⎙]()
-1. [Design and Analysis of Algorithms](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-046j-design-and-analysis-of-algorithms-spring-2012/) - [⎙]()
-1. [Paradigms of Computer Programming – Fundamentals](https://www.edx.org/course/paradigms-computer-programming-louvainx-louv1-1x-0) - [⎙]()
-1. [Paradigms of Computer Programming – Abstraction and Concurrency](https://www.edx.org/course/paradigms-computer-programming-louvainx-louv1-2x-0) - [⎙]()
-1. [Computer System Engineering](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-033-computer-system-engineering-spring-2009/) - [⎙]()
-1. [Computer Language Engineering](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-035-computer-language-engineering-spring-2010/) - [⎙]()
-1. [Great Ideas in Theoretical Computer Science](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-080-great-ideas-in-theoretical-computer-science-spring-2008/) - [⎙]()
-1. [Performance Engineering of Software Systems](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-172-performance-engineering-of-software-systems-fall-2010/) - [⎙]()
-1. [Engineering Innovation and Design](http://ocw.mit.edu/courses/engineering-systems-division/esd-051j-engineering-innovation-and-design-fall-2012/) - [⎙]()
-1. [Principles of Computer System Design: An Introduction](http://ocw.mit.edu/resources/res-6-004-principles-of-computer-system-design-an-introduction-spring-2009/) - [⎙]()
-1. [How to Process, Analyze and Visualize Data](http://ocw.mit.edu/resources/res-6-009-how-to-process-analyze-and-visualize-data-january-iap-2012/) - [⎙]()
-1. [Advanced Data Structures](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-851-advanced-data-structures-spring-2012/) - [⎙]()
-1. [Advanced Algorithms](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-854j-advanced-algorithms-fall-2008/) - [⎙]()
-1. [Distributed Algorithms](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-852j-distributed-algorithms-fall-2009/) - [⎙]()
-
-### Software Testing
-
-1. [Software Testing](https://www.udacity.com/course/software-testing--cs258) - [⎙]()
-1. [Software Debugging](https://www.udacity.com/course/software-debugging--cs259) - [⎙]()
-
-### Math
-
-1. [Mathematics for Computer Science](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-042j-mathematics-for-computer-science-fall-2010/) - [⎙]()
-1. [Introduction to Logic](https://www.coursera.org/course/intrologic) - [⎙]()
-1. [Linear Algebra](http://ocw.mit.edu/courses/mathematics/18-06-linear-algebra-spring-2010/) - [⎙]()
-1. [Coding the Matrix: Linear Algebra through Computer Science Applications](https://www.coursera.org/course/matrix) - [⎙]()
-1. [Calculus One](https://www.coursera.org/learn/calculus1) - [⎙]()
-1. [Calculus Two](https://www.coursera.org/learn/advanced-calculus) - [⎙]()
-1. [Linear and Discrete Optimization](https://www.coursera.org/course/linearopt) - [⎙]()
-1. [Probabilistic Graphical Models](https://www.coursera.org/course/pgm) - [⎙]()
-1. [Game Theory](https://www.coursera.org/course/gametheory) - [⎙]()
-1. [Statistics One](https://www.coursera.org/course/stats1) - [⎙]()
-1. [AP Statistics](http://stattrek.com/tutorials/ap-statistics-tutorial.aspx) - [⎙]()
-
-### Operating Systems
-
-1. [Operating System Engineering](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-828-operating-system-engineering-fall-2012/) - [⎙]()
-1. [Operating Systems and System Programming](https://www.youtube.com/watch?v=XgQo4JkN4Bw&list=PL3289DD0D0F0CD4A3) - [⎙]()
-
-### Networks
-
-1. [Networks](http://ocw.mit.edu/courses/economics/14-15j-networks-fall-2009/) - [⎙]()
-1. [Network and Computer Security](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-857-network-and-computer-security-spring-2014/) - [⎙]()
-1. [Network Optimization](http://ocw.mit.edu/courses/sloan-school-of-management/15-082j-network-optimization-fall-2010/) - [⎙]()
-
-### Databases
-
-1. [Database Systems](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-830-database-systems-fall-2010/) - [⎙]()
-1. [Database, Internet, and Systems Integration Technologies](http://ocw.mit.edu/courses/civil-and-environmental-engineering/1-264j-database-internet-and-systems-integration-technologies-fall-2013/) - [⎙]()
-
-### Cryptography
-
-1. [Cryptography I](https://www.coursera.org/course/crypto) - [⎙]()
-1. [Applied Cryptography](https://www.udacity.com/course/applied-cryptography--cs387) - [⎙]()
-
-### Compilers
-
-1. [Compilers](https://www.coursera.org/course/compilers) - [⎙]()
-
-### Artificial Intelligence
-
-1. [Artificial Intelligence](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-034-artificial-intelligence-fall-2010/) - [⎙]()
-
-### Machine Learning
-
-1. [Practical Machine Learning](https://www.coursera.org/course/predmachlearn) - [⎙]()
-1. [Machine Learning](https://www.coursera.org/learn/machine-learning) - [⎙]()
-1. [Neural Networks for Machine Learning](https://www.coursera.org/course/neuralnets) - [⎙]()
-
-### Natural Language Processing
-
-1. [Natural Language Processing](https://www.coursera.org/course/nlangp) - [⎙]()
-1. [Natural Language Processing](https://www.coursera.org/course/nlp) - [⎙]()
-
-### Robotics
-
-### Graphs
-
-### Data Mining
-
-1. [Data Mining](https://www.coursera.org/specialization/datamining/20?utm_medium=catalog) - [⎙]()
-
-### Parallel Programming
-
-1. [Parallel Computing](http://ocw.mit.edu/courses/mathematics/18-337j-parallel-computing-fall-2011/) - [⎙]()
-1. [Heterogeneous Parallel Programming](https://www.coursera.org/course/hetero) - [⎙]()
-
-### Programming Languages
-
-1. [Practical Programming in C](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-087-practical-programming-in-c-january-iap-2010/) - [⎙]()
-1. [Introduction to C Memory Management and C++ Object-Oriented Programming](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-088-introduction-to-c-memory-management-and-c-object-oriented-programming-january-iap-2010/) - [⎙]()
-1. [Effective Programming in C and C++](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-s096-effective-programming-in-c-and-c-january-iap-2014/) - [⎙]()
-
-### Others
-
-1. [Introduction to Functional Programming](https://www.edx.org/course/introduction-functional-programming-delftx-fp101x#!)
-1. [Engineering Software as a Service](https://www.edx.org/course/engineering-software-service-uc-berkeleyx-cs169-1x)
-1. [Engineering Software as a Service, Part 2](https://www.edx.org/course/engineering-software-service-part-2-uc-berkeleyx-cs169-2x#!)
-1. [Automata, Computability, and Complexity](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-045j-automata-computability-and-complexity-spring-2011/) - [⎙]()
-1. [Computational Biology: Genomes, Networks, Evolution](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-047-computational-biology-genomes-networks-evolution-fall-2008/) - [⎙]()
-1. [Creating Video Games](http://ocw.mit.edu/courses/comparative-media-studies-writing/cms-611j-creating-video-games-fall-2013/) - [⎙]()
-1. [Computer Graphics](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-837-computer-graphics-fall-2012/) - [⎙]()
-1. [User Interface Design and Implementation](http://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-831-user-interface-design-and-implementation-spring-2011/) - [⎙]()
-1. [Making Sense of Data](https://datasense.withgoogle.com/course) - [⎙]()
-1. [Data Science](https://www.coursera.org/specialization/jhudatascience/1?utm_medium=courseDescripTop) - [⎙]()
+
++ Path to a free self-taught education in Computer Science! +
+ + prompt.js | |
|---|---|
/*
- * prompt.js: Simple prompt for prompting information from the command line
- *
- * (C) 2010, Nodejitsu Inc.
- *
- */
-
-var events = require('events'),
- async = require('async'),
- colors = require('colors'),
- winston = require('winston'),
- stdio = process.binding('stdio'); | |
@private function capitalize (str)- -str {string} String to capitalize- -Capitalizes the string supplied. | function capitalize(str) {
- return str.charAt(0).toUpperCase() + str.slice(1);
-}
-
-var prompt = module.exports = Object.create(events.EventEmitter.prototype);
-
-var logger = prompt.logger = new winston.Logger({
- transports: [
- new (winston.transports.Console)()
- ]
-});
-
-prompt.started = false;
-prompt.paused = false;
-prompt.allowEmpty = false;
-
-var stdin, stdout; |
| Create an empty object for the properties
-known to | prompt.properties = {}; |
| Setup the default winston logger to use
-the | logger.cli(); |
function start (options)- -@options {Object} Optional Options to consume by prompt- -Starts the prompt by listening to the appropriate events on | prompt.start = function (options) {
- if (prompt.started) {
- return;
- }
-
- options = options || {};
- stdin = options.stdin || process.openStdin();
- stdout = options.stdout || process.stdout;
-
- prompt.allowEmpty = options.allowEmpty || false;
-
- process.on('SIGINT', function () {
- stdout.write('\n');
- process.exit(1);
- })
-
- prompt.emit('start');
- prompt.started = true;
- return prompt;
-}; |
function pause ()- -Pauses input coming in from stdin | prompt.pause = function () {
- if (!prompt.started || prompt.paused) {
- return;
- }
-
- stdin.pause();
- prompt.emit('pause');
- prompt.paused = true;
- return prompt;
-}; |
function resume ()- -Resumes input coming in from stdin | prompt.resume = function () {
- if (!prompt.started || !prompt.paused) {
- return;
- }
-
- stdin.resume();
- prompt.emit('resume');
- prompt.paused = false;
- return prompt;
-}; |
function get (msg, [validator,] callback)- -@msg {Array|Object|string} Set of variables to get input for.- -@callback {function} Continuation to pass control to when complete.- -Gets input from the user via stdin for the specified message(s) | prompt.get = function (msg, callback) {
- var vars = !Array.isArray(msg) ? [msg] : msg,
- result = {};
-
- vars = vars.map(function (v) {
- if (typeof v === 'string') {
- v = v.toLowerCase();
- }
-
- return prompt.properties[v] || v;
- });
-
- function get(target, next) {
- prompt.getInput(target, function (err, line) {
- if (err) {
- return next(err);
- }
-
- var name = target.name || target;
- result[name] = line;
- next();
- });
- }
-
- async.forEachSeries(vars, get, function (err) {
- return err ? callback(err) : callback(null, result);
- });
-
- return prompt;
-}; |
function getInput (msg, validator, callback)- -@msg {Object|string} Variable to get input for.- -@callback {function} Continuation to pass control to when complete.- -Gets input from the user via stdin for the specified message | prompt.getInput = function (prop, callback) {
- var name = prop.message || prop.name || prop,
- raw = ['prompt', ': ' + name.grey, ': '.grey],
- read = prop.hidden ? prompt.readLineHidden : prompt.readLine,
- length, msg;
-
- if (prop.default) {
- raw.splice(2, -1, ' (' + prop.default + ')');
- }
- |
| Calculate the raw length and colorize the prompt | length = raw.join('').length;
- raw[0] = raw[0];
- msg = raw.join('');
-
- if (prop.help) {
- prop.help.forEach(function (line) {
- logger.help(line);
- });
- }
-
- stdout.write(msg);
- prompt.emit('prompt', prop);
-
- read.call(null, function (err, line) {
- if (err) {
- return callback(err);
- }
-
- if (!line || line === '') {
- line = prop.default || line;
- }
-
- if (prop.validator || prop.empty === false) {
- var valid;
-
- if (prop.validator) {
- valid = prop.validator.test
- ? prop.validator.test(line)
- : prop.validator(line);
- }
-
- if (prop.empty === false && valid) {
- valid = line.length > 0;
- prop.warning = prop.warning || 'You must supply a value.';
- }
-
- if (!valid) {
- logger.error('Invalid input for ' + name.grey);
- if (prop.warning) {
- logger.error(prop.warning);
- }
-
- prompt.emit('invalid', prop, line);
- return prompt.getInput(prop, callback);
- }
- }
-
- logger.input(line.yellow);
- callback(null, line);
- });
-
- return prompt;
-}; |
function addProperties (obj, properties, callback)- -@obj {Object} Object to add properties to- -@properties {Array} List of properties to get values for- -@callback {function} Continuation to pass control to when complete.- -Prompts the user for values each of the | prompt.addProperties = function (obj, properties, callback) {
- properties = properties.filter(function (prop) {
- return typeof obj[prop] === 'undefined';
- });
-
- if (properties.length === 0) {
- return callback(obj);
- }
-
- prompt.get(properties, function (err, results) {
- if (err) {
- return callback(err);
- }
- else if (!results) {
- return callback(null, obj);
- }
-
- function putNested (obj, path, value) {
- var last = obj, key;
-
- while (path.length > 1) {
- key = path.shift();
- if (!last[key]) {
- last[key] = {};
- }
-
- last = last[key];
- }
-
- last[path.shift()] = value;
- }
-
- Object.keys(results).forEach(function (key) {
- putNested(obj, key.split('.'), results[key]);
- });
-
- callback(null, obj);
- });
-
- return prompt;
-}; |
function readLine (callback)- -@callback {function} Continuation to respond to when complete- -Gets a single line of input from the user. | prompt.readLine = function (callback) {
- var value = '', buffer = '';
- prompt.resume();
- stdin.setEncoding('utf8');
- stdin.on('error', callback);
- stdin.on('data', function data (chunk) {
- value += buffer + chunk;
- buffer = '';
- value = value.replace(/\r/g, '');
- if (value.indexOf('\n') !== -1) {
- if (value !== '\n') {
- value = value.replace(/^\n+/, '');
- }
-
- buffer = value.substr(value.indexOf('\n'));
- val = value.substr(0, value.indexOf('\n'));
- prompt.pause();
- stdin.removeListener('data', data);
- stdin.removeListener('error', callback);
- value = value.trim();
- callback(null, value);
- }
- });
-
- return prompt;
-}; |
function readLineHidden (callback)- -@callback {function} Continuation to respond to when complete- -Gets a single line of hidden input (i.e. | prompt.readLineHidden = function (callback) {
- var value = '', buffer = '';
- stdio.setRawMode(true);
- prompt.resume();
- stdin.on('error', callback);
- stdin.on('data', function data (c) {
- c = '' + c;
- switch (c) {
- case '\n': case '\r': case '\r\n': case '\u0004':
- stdio.setRawMode(false);
- stdin.removeListener('data', data);
- stdin.removeListener('error', callback);
- value = value.trim();
- stdout.write('\n');
- stdout.flush();
- prompt.pause();
- return callback(null, value)
- case '\u0003': case '\0':
- stdout.write('\n');
- process.exit(1);
- break;
- default:
- value += buffer + c
- buffer = '';
- break;
- }
- });
-
- return prompt;
-};
-
- |
pkginfo.js | |
|---|---|
/*
- * pkginfo.js: Top-level include for the pkginfo module
- *
- * (C) 2011, Charlie Robbins
- *
- */
-
-var fs = require('fs'),
- path = require('path'); | |
function pkginfo ([options, 'property', 'property' ..])- -@pmodule {Module} Parent module to read from.- -@options {Object|Array|string} Optional Options used when exposing properties.- -@arguments {string...} Optional Specified properties to expose.- -Exposes properties from the package.json file for the parent module on -it's exports. Valid usage: - -
| var pkginfo = module.exports = function (pmodule, options) {
- var args = [].slice.call(arguments, 2).filter(function (arg) {
- return typeof arg === 'string';
- });
- |
| Parse variable arguments | if (Array.isArray(options)) { |
| If the options passed in is an Array assume that -it is the Array of properties to expose from the -on the package.json file on the parent module. | options = { include: options };
- }
- else if (typeof options === 'string') { |
| Otherwise if the first argument is a string, then -assume that it is the first property to expose from -the package.json file on the parent module. | options = { include: [options] };
- }
- |
| Setup default options | options = options || { include: [] };
-
- if (args.length > 0) { |
| If additional string arguments have been passed in -then add them to the properties to expose on the -parent module. | options.include = options.include.concat(args);
- }
-
- var pkg = pkginfo.read(pmodule, options.dir).package;
- Object.keys(pkg).forEach(function (key) {
- if (options.include.length > 0 && !~options.include.indexOf(key)) {
- return;
- }
-
- if (!pmodule.exports[key]) {
- pmodule.exports[key] = pkg[key];
- }
- });
-
- return pkginfo;
-}; |
function find (dir)- -@pmodule {Module} Parent module to read from.- -@dir {string} Optional Directory to start search from.- -Searches up the directory tree from | pkginfo.find = function (pmodule, dir) {
- dir = dir || pmodule.filename;
- dir = path.dirname(dir);
-
- var files = fs.readdirSync(dir);
-
- if (~files.indexOf('package.json')) {
- return path.join(dir, 'package.json');
- }
-
- if (dir === '/') {
- throw new Error('Could not find package.json up from: ' + dir);
- }
-
- return pkginfo.find(dir);
-}; |
function read (pmodule, dir)- -@pmodule {Module} Parent module to read from.- -@dir {string} Optional Directory to start search from.- -Searches up the directory tree from | pkginfo.read = function (pmodule, dir) {
- dir = pkginfo.find(pmodule, dir);
-
- var data = fs.readFileSync(dir).toString();
-
- return {
- dir: dir,
- package: JSON.parse(data)
- };
-}; |
| Call | pkginfo(module, {
- dir: __dirname,
- include: ['version'],
- target: pkginfo
-});
-
- |
object against a JSON Schema.
- // If object is self-describing (i.e. has a
- // $schema property), it will also be validated
- // against the referenced schema. [TODO]: This behaviour bay be
- // suppressed by setting the {@link #validate.options.???}
- // option to ???.[/TODO]
- //
- // If schema is not specified, and object
- // is not self-describing, validation always passes.
- //
- // Note: in order to pass options but no schema,
- // schema must be specified in the call to
- // validate(); otherwise, options will
- // be interpreted as the schema. schema may be passed
- // as null, undefinded, or the empty object
- // ({}) in this case.
- //
- function validate(object, schema, options) {
- options = mixin({}, options, validate.defaults);
- var errors = [];
-
- validateObject(object, schema, options, errors);
-
- //
- // TODO: self-described validation
- // if (! options.selfDescribing) { ... }
- //
-
- return {
- valid: !(errors.length),
- errors: errors
- };
- };
-
- /**
- * Default validation options. Defaults can be overridden by
- * passing an 'options' hash to {@link #validate}. They can
- * also be set globally be changing the values in
- * validate.defaults directly.
- */
- validate.defaults = {
- /**
- * - * Enforce 'format' constraints. - *
- * Default: true
- *
- * When {@link #validateFormats} is true,
- * treat unrecognized formats as validation errors.
- *
- * Default: false
- *
- * When {@link #validateFormats} is true,
- * also validate formats defined in {@link #validate.formatExtensions}.
- *
- * Default: true
- *