@proteinjs/conversation 1.0.1

package/src/template/createApp/CreateAppTemplate.ts

@@ -0,0 +1,33 @@
+import { getFilePathsMatchingGlobFunctionName } from '../../fs/conversation_fs/FsFunctions';
+import { ConversationTemplate, Question } from '../ConversationTemplate';
+
+const createAppQuestions: Question[] = [
+  {
+    text: 'What is the name of the app you want to create?',
+  },
+  {
+    text: 'Which directory would you like to create the app in?',
+  },
+];
+
+const createAppInstructions = async () => {
+  // Here we would implement the instructions based on the user's answers to the questions
+  return [
+    'create a directory for the app (if it doesnt already exist), with the same name as the app (replace ` ` with `-`)',
+    'cloneAppTemplatePackages on the app directory',
+    'update the package.json files of the packages you just cloned, set the package names to be app-name-ui and app-name-server',
+    `update the ui/src/Container.tsx and ui/src/SplashPage.tsx files to replace the occurrences of 'appName' with their app name in each file`,
+    'npmInstall each newly cloned package',
+    'runPackageScript(`build`, cwd) each newly cloned package',
+    'describe the packages',
+    'tell the user they can start the server by calling `npm run dev` in the server package',
+  ];
+};
+
+export const createAppTemplate: ConversationTemplate = {
+  name: 'Create App',
+  keywords: ['create', 'app', 'create app', 'create new app'],
+  description: 'This template will guide you through the process of creating a new app.',
+  questions: createAppQuestions,
+  instructions: createAppInstructions,
+};

package/src/template/createCode/CreateCodeConversationTemplate.ts

@@ -0,0 +1,41 @@
+import { fileOrDirectoryExistsFunction, readFilesFunctionName } from '../../fs/conversation_fs/FsFunctions';
+import { generateTypescriptDeclarationsFunction, installPackagesFunction, searchLibrariesFunctionName, searchPackagesFunctionName } from '../../fs/package/PackageFunctions';
+import { ConversationTemplate } from '../ConversationTemplate';
+
+export const createCodeConversationTemplate: ConversationTemplate = {
+  name: 'Create code',
+  keywords: [
+    'create code',
+    'implement',
+    'write code',
+    'generate code',
+    'write software',
+    'build something',
+  ],
+  description: 'User and ai developing together',
+  questions: [],
+  instructions: async () => {
+    return [
+      `You are going to generate code for the user, follow these steps:`,
+      `1. Confirm the package they want to work in, if the user didn't already provide one`,
+      `1.a. Use the ${searchPackagesFunctionName} function to identify the package.json file path`,
+      `1.b. Use the ${readFilesFunctionName} function to read the package.json file, reference this throughout the conversation in the fileSystem`,
+      `1.c. Set the cwd to the directory of the package.json file`,
+      `2. Ask for a file name to work in, if the user didn't alrady provide one`,
+      `2.a. Whenever the user wants to create a new source file, default to creating it in the package src/ folder`,
+      `2.b. Confirm the package-relative file path with the user. Only after the users confirms the path, create the file if it doesn't exist`,
+      `2.b.1. Use the ${fileOrDirectoryExistsFunction.definition.name} function to confirm if a file exists`,
+      `3. Once working in a file, ask the user what they'd like to create`,
+      `3.a. If the user references a library, use the ${searchLibrariesFunctionName} function to identify local libraries that can be imported`,
+      `3.a.1. Confirm the library file name and package name with the user, if they provide a different library or package name, repeat step 3.a.`,
+      `3.a.2. Call the ${generateTypescriptDeclarationsFunction.definition.name} function to get the typescript declaration of the library file`,
+      `3.a.3. Use the typescript declaration and the package name to add the import statements to the top of the file`,
+      `3.a.4. Use the ${readFilesFunctionName} function on the package.json if it's not in the fileSystem`,
+      `3.a.5. Check the pacakge.json dependencies, if the imported package is not already a dependency, use the ${installPackagesFunction.definition.name} function to install it`,
+      `3.a.5.a. Use the ${searchPackagesFunctionName} on the import package to derermine if it's in the local repo; if it is, calculate the relative path from the cwd package to the package being installed, use that path as the version when installing the package`,
+      `3.b. Generate the code the user asked to create, leveraging the imported library where appropriate`,
+      `3.c. When writing the code to file, if updating an existing file, be sure to read the file first to not blow away existing code. Be sure to preserve comments as well.`,
+      `4. Repeat 3. unless the user asks to switch packages or files`,
+    ];
+  }
+}

package/src/template/createPackage/CreatePackageConversationTemplate.ts

@@ -0,0 +1,42 @@
+import { Fs } from '@proteinjs/util-node';
+import { ConversationTemplate } from '../ConversationTemplate';
+import path from 'path';
+import tConfig from './tsconfig.json';
+
+export const createPackageConversationTemplate: ConversationTemplate = {
+  name: 'Create Package',
+  keywords: [
+    'package',
+    'create package',
+    'create',
+    'create a package',
+    'create a new package',
+    `new package`,
+  ],
+  description: 'Create a npm package',
+  questions: [
+    { text: `Which folder should the package be created in?` },
+    { text: `What should the package name be?` },
+    { text: `What should the package version be?`, optional: true },
+    { text: `Is this a typescript project?` },
+    { text: `Are there any default dependencies you'd like to include?`, optional: true },
+  ],
+  instructions: async () => {
+    const jestConfig = await Fs.readFile(path.join(__dirname, `./jest.config.js`));
+    const tsConfig = await Fs.readFile(path.join(__dirname, `./tsconfig.json`));
+    return [
+      `Create a new package.json with the provided name, version (if one wasn't provided, default to 0.1), and any default dependencies provided`,
+      `Create the package.json in the specified folder, do not create subfolders from the package name`,
+      `If the folder does not exist, create the folder`,
+      `Add these scripts to the package.json: "start": "node ./dist/index.js", "test": "jest"`,
+      `Add these dev dependencies to the package.json: jest`,
+      `If it's a typescript project, add these dev dependencies: @types/jest, ts-jest`,
+      `If it's a typescript project, add these scripts: "watch": "tsc -w -p ."`,
+      `Create an index file in the package root directory (choose extension based on if it's a typescript project or not)`,
+      `Create the following folders in the package directory: src, test`,
+      `Create a jest.config.js file in the test directory with the following content: ${jestConfig}`,
+      `Create a .gitignore file in the package directory that ignores the node_modules and dist directories`,
+      `If it's a typescript project, create a tsconfig.json file in the pakage directory with the following content: ${tsConfig}`,
+    ];
+  },
+}

package/src/template/createPackage/jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  testMatch: ["**/?(*.)+(spec|test).ts"],
+  setupFiles: ['./test/setup'],
+};

package/src/template/createPackage/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "commonjs",
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}

package/test/createKeywordFilesIndex.test.ts

@@ -0,0 +1,7 @@
+import { KeywordToFilesIndexModuleFactory } from '../src/fs/keyword_to_files_index/KeywordToFilesIndexModule';
+
+test('Create keyword-files index', async() => {
+  // Example usage
+  const index = new KeywordToFilesIndexModuleFactory().createKeywordFilesIndex(`${process.cwd()}`)
+  console.log(JSON.stringify(index, null, 2));
+}, 60000)

package/test/openai/openai.generateList.test.ts

@@ -0,0 +1,6 @@
+import { OpenAi } from "../../src/OpenAi";
+
+test('generateList should return an array of numbers, counting to 10', async () => {
+  const numbers = ['one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten'];
+  expect((await OpenAi.generateList([`Create a list of numbers spelled out, from 1 to 10`])).join(' ')).toBe(numbers.join(' '));
+});

package/test/openai/openai.parseCodeFromMarkdown.test.ts

@@ -0,0 +1,20 @@
+import { OpenAi } from "../../src/OpenAi";
+
+const helloWorldCode = "console.log('hello world');";
+const helloWorldWithTicksCode = "console.log('hello ```world');";
+const logXCode = "const x = 'yo';\nconsole.log(x);";
+const testOneBlock = "Sure! I'm a helpful chatbot.\n```typescript\n" + helloWorldCode + "\n```";
+const testOneBlockWithExtraTicks = "Sure! I'm a helpful chatbot.\n```typescript\n" + helloWorldWithTicksCode + "\n```";
+const testTwoBlocks = "Sure! I'm a helpful chatbot.\n```typescript\n" + helloWorldCode + "\n```\n\nI'm still really helpful.\n```typescript\n" + logXCode + "\n```\n\nMore unhelpful chat";
+
+test('parseCodeFromMarkdown should parse 1 block of code', () => {
+  expect(OpenAi.parseCodeFromMarkdown(testOneBlock)).toBe(helloWorldCode);
+});
+
+test('parseCodeFromMarkdown should parse 1 block of code that contains ticks', () => {
+  expect(OpenAi.parseCodeFromMarkdown(testOneBlockWithExtraTicks)).toBe(helloWorldWithTicksCode);
+});
+
+test('parseCodeFromMarkdown should parse 1 block of code', () => {
+  expect(OpenAi.parseCodeFromMarkdown(testTwoBlocks)).toBe(helloWorldCode + '\n\n' + logXCode);
+});

package/test/repo/repo.test.ts

@@ -0,0 +1,33 @@
+import { RepoFactory } from '../../src/code_template/Repo';
+// import { Table } from 'conversation/src/table';
+import { Conversation } from '../../src/Conversation';
+import { Fs } from '@proteinjs/util-node';
+
+
+// test(`Return repo of the source files and the code they depend on`, async () => {
+//   const tableTemplatePath = require.resolve('conversation/src/table.ts');
+//   const repo = await new RepoFactory([tableTemplatePath]).create();
+//   console.log(JSON.stringify(Object.keys(repo.declarations), null, 2));
+// }, 60000);
+
+// test(`It should be able to reference code`, async () => {
+
+// }, 60000);
+
+// test(`Interpret all parameters of a function`, async () => {
+  
+// }, 60000);
+
+// test(`Gather parameter data from the user`, async () => {
+//   const conversation = new Conversation();
+  
+// }, 60000);
+
+// test(`Generate code from templates guided by user input`, async () => {
+
+// }, 60000);
+
+test(`Create repo`, async () => {
+  // console.log(JSON.stringify((await RepoFactory.createRepo(`${process.cwd()}`)).params, null, 4));
+  // console.log(JSON.stringify(await Fs.getFilesInDirectory(`${process.cwd()}`, ['node_modules', 'dist']), null, 4));
+}, 60000)

package/tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    "resolveJsonModule": true,                           /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    "allowJs": true,                                     /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}