Global

Members

PEOPLE_MEMORY

Memory of the people I want to be thinking on.

Source:

(constant) ProblemsManager

Run tests based on the solved examples, check at least that for the solved examples everything runs smoothly.

Source:

(constant) assert

Problems with Arrays.

Source:

dfd

A couple of functionalities managing csv such as creating reports, auto populating items and also searching images from the web

Source:

Methods

commitCategory(commitMessage, strict) → {string}

Parameters:
Name Type Default Description
commitMessage string

Message to commit
strict bool false

If true, it will only detect categories when they appear followed by '|' e.g. 'feat |'
Source:
Returns:

category code e.g. 'feat'

Type
string

(async) commitpush(addMaidEmoji, addCommitEmoji, debug)

Pushes to origin with a commit message If it contains any of the specials categories (configurable in settings.js) it will log it in the feature (habit) database.

Parameters:
Name Type Description
addMaidEmoji bool

?= true : If to whether to add a maid emoji
addCommitEmoji bool

?= true : If to whether to add a commit emoji
debug bool

?= false : If to whether to debug api responses, etc.
Source:
Returns:

countDecimals(value) → {number}

Counts the decimals.

Parameters:
Name Type Description
value number

Number to count decimals
Source:
Returns:

Number of decimals

Type
number

createCompiledJson()

Creates a compiled json file from all the markdown files in the prompt directory

Source:

get()

Returns the cocards on the entire managmenet

Source:

getAbsoluteUri(fileimage) → {str}

Gets clickeable path that could be printed on the console and clicked.

Parameters:
Name Type Default Description
fileimage str ./img/unicorn.png

: String containing the relative position of the image from utils directory
Source:
Returns:

Formatted file:///C:/github/testing/mastery-cli/img/unicorn.png

Type
str

getAbsoluteUri(fileimage) → {str}

Gets clickeable path that could be printed on the console and clicked.

Parameters:
Name Type Default Description
fileimage str ./img/unicorn.png

: String containing the relative position of the image from utils directory
Source:
Returns:

Formatted file:///C:/github/testing/mastery-cli/img/unicorn.png

Type
str

(async) getComments(term, count)

Parameters:
Name Type Default Description
term string

the term to search for comments
count number 5

the number of comments to retrieve
Source:
Returns:

getCredentialInformation()

Retrieves fromt the json the proper credentials as n object

Source:

getDirAbsoluteUri(fileimage) → {str}

Gets directory path

Parameters:
Name Type Default Description
fileimage str ./img/unicorn.png

: String containing the relative position of the image from utils directory
Source:
Returns:

Formatted file:///C:/github/testing/mastery-cli/img/unicorn.png

Type
str

getDirAbsoluteUri(fileimage) → {str}

Gets directory path

Parameters:
Name Type Default Description
fileimage str ./img/unicorn.png

: String containing the relative position of the image from utils directory
Source:
Returns:

Formatted C:/github/testing/mastery-cli/img/unicorn.png

Type
str

getFilesInDirectory(directoryPath)

Parameters:
Name Type Default Description
directoryPath string ./data/priorities

'./data/priorities'
Source:
Returns:

Promise that resolves to the files in the directory

getMaidDirectory() → {str}

Return the absolute path of the codebase

Source:
Returns:

Formatted full Directory of the codebase e.g. C:/github/testing/mastery-cli

Type
str

getObjectiveFeatures()

based on the objectives_features at Settings returns in the format of:

const feat_rules = {
	terms: {
		description: "Terminologies practiced",
		week: 100
	},
	pro: {
		description: "Professional Projects",
		week: 3 * 5
	},
	feat: {
		description: "Features for personal projects",
		week: 1 * 5 + 2 * 3
	},
	acad: {
		description: "Academic Projects / Assignments / notes added",
		week: 1 * 5
	}
	...
}
Source:

(async) getPromptDict(prompt_slug) → {Object}

Checks if prompt.json exists, if not, creates it, then returns the parsed json

Parameters:
Name Type Description
prompt_slug String

The slug of the prompt to return, if empty, returns all prompts
Source:
Returns:

parsed_prompt_dict

Type
Object

getRandomBool()

Source:
Returns:

Random Bool

getRandomBool()

Source:
Returns:

Random Bool

get_random(list)

Parameters:
Name Type Description
list
Source:
Returns:

any # picks the object and returns it. | If however the specified count of random objects is greater than the list, then it will return a list of random elements of that size.

get_random(list)

Parameters:
Name Type Description
list
Source:
Returns:

any # picks the object and returns it.

get_random_of_size(list, count)

Parameters:
Name Type Description
list
count int

The number of random objects to pick from the list. Default is 1.
Source:
Returns:

increasePerformance(feature_name:, increaseBY:, debug, account_id)

Waiting for pgAdmin 4 to start... * Increase the performance of a feature; Day performances are such as commits, features, etc.

Parameters:
Name Type Description
feature_name: str

The name of the feature to increase
increaseBY: int

The amount to increase the feature by; default 1
debug bool

?= false : If to whether to debug api responses, etc.; default false
account_id int

?= 1 : The account id to increase the performance; default Settings account_id or 1
Source:

(async) logCommitIfSpecialCategory(commitMessage, category, print_previous_commits, debug)

logs commit message in comments database if category is special

Parameters:
Name Type Description
commitMessage string

message to commit
category ECommitCategory

category of the commit
print_previous_commits bool

?= true : If to whether to print previous commits
debug bool

?= false : If to whether to debug api responses, etc.
Source:
Returns:

(async) openEditorPlatformAgnostic(editor_instruction, absolute_temp_file_path)

Opens the editor with the given instruction and the absolute path of the file

Parameters:
Name Type Description
editor_instruction string

e.g. code, vim, nano, etc.
absolute_temp_file_path string

e.g. /home/username/.../temp.js
Source:

(async) openEditorWithCommand(Returns)

Open the editor with the given instruction

Parameters:
Name Type Description
Returns Awaited.<void>

once the editor is closed
Source:

populateLastDaysFeaturesBarCharts()

Based on the speciffied feature it returns the corresponsive barcharts

Source:

populateLastDaysPerformanceReport()

Expected output: {month: {}, lastweek: {}, yesterday: {}, today: {}}

Source:

(async) postCommentFromTerm(user_res:, debug)

Based on a term and response written by the user it should post things in the comments based on that.

Parameters:
Name Type Description
user_res: str

Response answered by the user on the terminal
debug bool

?= False : If to whether to debug api responses, etc.
Source:

printComments()

Prints the comments in a nice format

Parameters:
Type Description
Source:

printMarked(content, use_markdown, markdown_token)

Prints the content as markdown if it is markdown, otherwise it will just print the content

Parameters:
Name Type Description
content string

The String content that can be either markdown or not, determined by :m
use_markdown boolean

If true then it will use markdown, if false then it will just print the content
markdown_token string

The token that determines if the content is markdown or not
Source:

(async) show_image(image_file, is_url)

Shows an image, if it is a url then it will fetch it, otherwise it will read it from the local file

Parameters:
Name Type Description
image_file string

Image of the file to show
is_url is_url

Whether the image is a url or not
Source:

(async) show_image_if_isurl()

Prints the image if it is a url

Source:

updateConcept(problem_name:, success, debug, account_id)

Updates the count of times a concept has been practiced e.g. algebra-problem-1 or 'js-how-to-loop'

Parameters:
Name Type Description
problem_name: str

The name of the problem to update
success bool

?= true : If to whether to increase the success count or the fail count
debug bool

?= false : If to whether to debug api responses, etc.
account_id int

?= 1 : The account id to increase the performance; default Settings account_id or 1
Source:
Returns:

user_requests_calc(res) → {boolean}

Returns whether the user wants to open a calculator node. (for now a js node would work.)

Parameters:
Name Type Description
res str

: User input
Source:
Returns:

: True if user wants to calculate, false otherwise

Type
boolean

user_requests_exit(res) → {boolean}

Returns whether the user wants to exit.

Parameters:
Name Type Description
res str

: User input
Source:
Returns:

: True if user wants to exit, false otherwise

Type
boolean

user_requests_skip(res) → {boolean}

Returns whether the user wants to skip the problem.

Parameters:
Name Type Description
res boolean

: User input
Source:
Returns:

: True if user wants to skip, false otherwise

Type
boolean

value(filename)

Parameters:
Name Type Description
filename String

Populates the coefficients with the right data.
Source:

value() → {number}

Returns the amount of cards left to learn.

Source:
Returns:
Type
number

value(wasCorrect)

Parameters:
Name Type Description
wasCorrect bool

If the solution was correct or not returns {integer} count of cards left to be studied.
Source: