@codecademy/codebytes 0.2.1-alpha.cfe771.0 → 0.3.1-alpha.aae5d5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,7 +3,7 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
- ### [0.2.1-alpha.cfe771.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.2.0...@codecademy/codebytes@0.2.1-alpha.cfe771.0) (2022-01-07)
6
+ ### [0.3.1-alpha.aae5d5.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.3.0...@codecademy/codebytes@0.3.1-alpha.aae5d5.0) (2022-01-13)
7
7
 
8
8
  **Note:** Version bump only for package @codecademy/codebytes
9
9
 
@@ -11,6 +11,15 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
11
11
 
12
12
 
13
13
 
14
+ ## [0.3.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.2.0...@codecademy/codebytes@0.3.0) (2022-01-12)
15
+
16
+
17
+ ### Features
18
+
19
+ * **Codebytes:** add simple monaco editor disc 353 ([#16](https://github.com/Codecademy/client-modules/issues/16)) ([eec98ba](https://github.com/Codecademy/client-modules/commit/eec98ba9aad45f07fb5f3417e3da1e1935985deb))
20
+
21
+
22
+
14
23
  ## [0.2.0](https://github.com/Codecademy/client-modules/compare/@codecademy/codebytes@0.1.0...@codecademy/codebytes@0.2.0) (2022-01-04)
15
24
 
16
25
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@codecademy/codebytes",
3
3
  "description": "Codebytes Code Editor",
4
- "version": "0.2.1-alpha.cfe771.0",
4
+ "version": "0.3.1-alpha.aae5d5.0",
5
5
  "author": "Codecademy Engineering <dev@codecademy.com>",
6
6
  "sideEffects": [
7
7
  "**/*.css",
@@ -26,9 +26,8 @@
26
26
  "@codecademy/variance": "*",
27
27
  "@emotion/react": "^11.4.0",
28
28
  "@emotion/styled": "^11.3.0",
29
- "@loadable/component": "^5.13.1",
30
- "monaco-editor": "0.20.0",
31
- "react-monaco-editor": "0.34.0",
29
+ "@monaco-editor/react": "4.3.1",
30
+ "monaco-editor": ">= 0.25.0 < 1",
32
31
  "react-resize-observer": "1.1.1"
33
32
  },
34
33
  "scripts": {
@@ -44,11 +43,10 @@
44
43
  "@emotion/jest": "^11.3.0",
45
44
  "@testing-library/dom": "^7.31.2",
46
45
  "@testing-library/react": "^11.0.4",
47
- "@types/loadable__component": "^5.13.2",
48
- "monaco-editor-webpack-plugin": "1.9.1"
46
+ "@types/loadable__component": "^5.13.2"
49
47
  },
50
48
  "publishConfig": {
51
49
  "access": "public"
52
50
  },
53
- "gitHead": "152cbfee536dbc4fb1ac52fcd4ee6a82f25def61"
51
+ "gitHead": "c945b270cb11bdc3d44a237003263c05dc5a188b"
54
52
  }
@@ -3,48 +3,51 @@
3
3
  // We are working on a monaco package in client-modules that has more configuration around themes and languages
4
4
  // Monaco as a shared package RFC https://www.notion.so/codecademy/Monaco-editor-as-a-shared-package-1f4484db165b4abc8394c3556451ef6a
5
5
 
6
- import loadable from '@loadable/component';
6
+ import ReactMonacoEditor, { OnMount } from '@monaco-editor/react';
7
+ import { editor } from 'monaco-editor/esm/vs/editor/editor.api';
7
8
  import React, { useCallback, useRef } from 'react';
8
- import MonacoEditor from 'react-monaco-editor';
9
9
  import ResizeObserver from 'react-resize-observer';
10
10
 
11
11
  import { dark } from './theme';
12
12
  import { Monaco } from './types';
13
13
 
14
- const ReactMonacoEditor = loadable(() => import('react-monaco-editor'));
15
-
16
14
  export type SimpleMonacoEditorProps = {
17
15
  value: string;
18
16
  language: string;
19
17
  onChange?: (value: string) => void;
20
18
  };
21
19
 
20
+ type ThemedEditor = Parameters<OnMount>[0];
21
+
22
22
  export const SimpleMonacoEditor: React.FC<SimpleMonacoEditorProps> = ({
23
23
  value,
24
24
  language,
25
25
  onChange,
26
26
  }) => {
27
- const editorRef = useRef<MonacoEditor>(null);
28
- const editorWillMount = useCallback((monaco: Monaco) => {
29
- monaco.editor.defineTheme('dark', dark);
30
- monaco.editor.setTheme('dark');
31
- }, []);
27
+ const editorRef = useRef<editor.IStandaloneCodeEditor | null>(null);
28
+ const editorWillMount = useCallback(
29
+ (editor: ThemedEditor, monaco: Monaco) => {
30
+ editorRef.current = editor;
31
+ monaco.editor.defineTheme('dark', dark);
32
+ monaco.editor.setTheme('dark');
33
+ },
34
+ []
35
+ );
32
36
  return (
33
37
  <>
34
38
  <ResizeObserver
35
39
  onResize={({ height, width }) => {
36
- editorRef.current?.editor?.layout({
40
+ editorRef.current?.layout({
37
41
  height,
38
42
  width,
39
43
  });
40
44
  }}
41
45
  />
42
46
  <ReactMonacoEditor
43
- ref={editorRef}
44
- editorWillMount={editorWillMount}
47
+ onMount={editorWillMount}
45
48
  onChange={onChange}
46
49
  options={{ minimap: { enabled: false } }}
47
- theme="dark"
50
+ theme="vs-dark"
48
51
  value={value}
49
52
  language={language}
50
53
  />
package/src/consts.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // key = language param to send to snippets service
2
2
  // val = label in language selection drop down
3
3
  export const languageOptions = {
4
- '': 'Select your language',
4
+ '': 'Select a language',
5
5
  cpp: 'C++',
6
6
  csharp: 'C#',
7
7
  golang: 'Go',
@@ -13,3 +13,52 @@ export const languageOptions = {
13
13
  };
14
14
 
15
15
  export type languageOption = keyof typeof languageOptions;
16
+
17
+ export const validLanguages = Object.keys(languageOptions).filter(
18
+ (option) => !!option
19
+ ) as languageOption[];
20
+
21
+ const cpp = `#include <iostream>
22
+ int main() {
23
+ std::cout << "Hello world!";
24
+ return 0;
25
+ }`;
26
+
27
+ const csharp = `namespace HelloWorld {
28
+ class Hello {
29
+ static void Main(string[] args) {
30
+ System.Console.WriteLine("Hello world!");
31
+ }
32
+ }
33
+ }`;
34
+
35
+ const golang = `package main
36
+ import "fmt"
37
+ func main() {
38
+ fmt.Println("Hello world!")
39
+ }`;
40
+
41
+ const javascript = "console.log('Hello world!');";
42
+
43
+ const php = `<?php
44
+ echo "Hello world!";
45
+ ?>`;
46
+
47
+ const python = "print('Hello world!')";
48
+
49
+ const ruby = 'puts "Hello world!"';
50
+
51
+ const scheme = `(begin
52
+ (display "Hello world!")
53
+ (newline))`;
54
+
55
+ export const helloWorld: { [key in languageOption]?: string } = {
56
+ cpp,
57
+ csharp,
58
+ golang,
59
+ javascript,
60
+ php,
61
+ python,
62
+ ruby,
63
+ scheme,
64
+ };
package/src/editor.tsx CHANGED
@@ -6,10 +6,10 @@ import {
6
6
  ToolTip,
7
7
  } from '@codecademy/gamut';
8
8
  import { CopyIcon } from '@codecademy/gamut-icons';
9
- import { colors } from '@codecademy/gamut-styles';
10
9
  import styled from '@emotion/styled';
11
10
  import React, { useState } from 'react';
12
11
 
12
+ import { CodebytesChangeHandlerMap } from '.';
13
13
  import { postSnippet } from './api';
14
14
  import type { languageOption } from './consts';
15
15
  import { Drawers } from './drawers';
@@ -25,7 +25,7 @@ const Output = styled.pre<{ hasError: boolean }>`
25
25
  overflow: auto;
26
26
  ${({ hasError, theme }) => `
27
27
  color: ${hasError ? theme.colors.orange : theme.colors.white};
28
- background-color: ${colors['gray-900']};
28
+ background-color: ${theme.colors['navy-900']};
29
29
  `}
30
30
  `;
31
31
 
@@ -39,11 +39,9 @@ type EditorProps = {
39
39
  hideCopyButton: boolean;
40
40
  language: languageOption;
41
41
  text: string;
42
- // eslint-disable-next-line react/no-unused-prop-types
43
- onChange: (
44
- text: string
45
- ) => void /* TODO: Add onChange behavior in DISC-353 */;
46
- onCopy?: (text: string, language: string) => void;
42
+
43
+ onChange: (text: string) => void;
44
+ on?: Pick<CodebytesChangeHandlerMap, 'copy' | 'run'>;
47
45
  snippetsBaseUrl?: string;
48
46
  };
49
47
 
@@ -51,7 +49,7 @@ export const Editor: React.FC<EditorProps> = ({
51
49
  language,
52
50
  text,
53
51
  hideCopyButton,
54
- onCopy,
52
+ on,
55
53
  onChange,
56
54
  snippetsBaseUrl,
57
55
  }) => {
@@ -64,7 +62,7 @@ export const Editor: React.FC<EditorProps> = ({
64
62
  .writeText(text)
65
63
  // eslint-disable-next-line no-console
66
64
  .catch(() => console.error('Failed to copy'));
67
- onCopy?.(text, language);
65
+ on?.copy?.(text, language);
68
66
  setIsCodeByteCopied(true);
69
67
  }
70
68
  };
@@ -84,6 +82,7 @@ export const Editor: React.FC<EditorProps> = ({
84
82
  };
85
83
  setStatus('waiting');
86
84
  setOutput('');
85
+ on?.run?.();
87
86
 
88
87
  try {
89
88
  const response = await postSnippet(data, snippetsBaseUrl);
package/src/index.tsx CHANGED
@@ -5,17 +5,26 @@ import { StyleProps } from '@codecademy/variance';
5
5
  import styled from '@emotion/styled';
6
6
  import React, { useState } from 'react';
7
7
 
8
- import { languageOption } from './consts';
8
+ import { helloWorld, languageOption } from './consts';
9
9
  import { Editor } from './editor';
10
+ import { LanguageSelection } from './languageSelection';
11
+
12
+ type CodebytesChangeHandler = (text: string, language: languageOption) => void;
13
+ export type CodebytesChangeHandlerMap = {
14
+ logoClick?: () => void;
15
+ edit?: CodebytesChangeHandler;
16
+ languageChange?: CodebytesChangeHandler;
17
+ copy?: CodebytesChangeHandler;
18
+ run?: () => void;
19
+ };
10
20
 
11
21
  export interface CodeByteEditorProps {
12
22
  text: string;
13
23
  language: languageOption;
14
24
  hideCopyButton: boolean;
15
- onCopy?: (text: string, language: string) => void;
16
25
  isIFrame?: boolean;
17
26
  snippetsBaseUrl?: string /* TODO in DISC-353: Determine best way to host and include snippets endpoint for both staging and production in both the monolith and next.js repo. */;
18
- onTextChange?: (text: string) => void;
27
+ on?: CodebytesChangeHandlerMap;
19
28
  }
20
29
 
21
30
  const editorStates = states({
@@ -42,14 +51,14 @@ const EditorContainer = styled(Background)<EditorStyleProps>(
42
51
 
43
52
  export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
44
53
  text: initialText,
45
- language,
54
+ language: initialLanguage,
46
55
  hideCopyButton,
47
- onCopy,
48
56
  isIFrame = false,
49
- snippetsBaseUrl = '',
50
- onTextChange,
57
+ on,
58
+ snippetsBaseUrl = process.env.CONTAINER_API_BASE,
51
59
  }) => {
52
60
  const [text, setText] = useState<string>(initialText);
61
+ const [language, setLanguage] = useState<languageOption>(initialLanguage);
53
62
  return (
54
63
  <EditorContainer bg="black" as="main" isIFrame={isIFrame}>
55
64
  <Box borderBottom={1} borderColor="gray-900" py={4} pl={8}>
@@ -60,19 +69,31 @@ export const CodeByteEditor: React.FC<CodeByteEditorProps> = ({
60
69
  target="_blank"
61
70
  rel="noreferrer"
62
71
  aria-label="visit codecademy.com"
72
+ onClick={() => on?.logoClick?.()}
63
73
  />
64
74
  </Box>
65
- <Editor
66
- language={language}
67
- text={text}
68
- hideCopyButton={hideCopyButton}
69
- onChange={(newText: string) => {
70
- setText(newText);
71
- onTextChange?.(newText);
72
- }}
73
- onCopy={onCopy}
74
- snippetsBaseUrl={snippetsBaseUrl}
75
- />
75
+ {language ? (
76
+ <Editor
77
+ language={language}
78
+ text={text}
79
+ hideCopyButton={hideCopyButton}
80
+ onChange={(newText: string) => {
81
+ setText(newText);
82
+ on?.edit?.(newText, language);
83
+ }}
84
+ on={on}
85
+ snippetsBaseUrl={snippetsBaseUrl}
86
+ />
87
+ ) : (
88
+ <LanguageSelection
89
+ onChange={(newLanguage) => {
90
+ const newText: string = text || helloWorld[newLanguage] || '';
91
+ setLanguage(newLanguage);
92
+ setText(newText);
93
+ on?.languageChange?.(newText, newLanguage);
94
+ }}
95
+ />
96
+ )}
76
97
  </EditorContainer>
77
98
  );
78
99
  };
@@ -0,0 +1,45 @@
1
+ import { Select } from '@codecademy/gamut';
2
+ import { Background } from '@codecademy/gamut-styles';
3
+ import styled from '@emotion/styled';
4
+ import React from 'react';
5
+
6
+ import type { languageOption } from './consts';
7
+ import { languageOptions } from './consts';
8
+
9
+ const StyledSelect = styled(Select)`
10
+ margin-top: 1rem;
11
+ color: ${({ theme }) => theme.colors.text};
12
+ select {
13
+ color: ${({ theme }) => theme.colors.text};
14
+ background-color: ${({ theme }) => theme.colors.black};
15
+
16
+ &:hover,
17
+ &:active,
18
+ &:focus {
19
+ border-color: ${({ theme }) => theme.colors.primary};
20
+ }
21
+ &:focus {
22
+ box-shadow: inset 0 0 0 1px ${({ theme }) => theme.colors.primary};
23
+ }
24
+ }
25
+ `;
26
+
27
+ export type LanguageSelectionProps = {
28
+ onChange: (newLanguage: languageOption) => void;
29
+ };
30
+
31
+ export const LanguageSelection: React.FC<LanguageSelectionProps> = ({
32
+ onChange,
33
+ }) => {
34
+ return (
35
+ <Background bg="black" flex={1} px={16} pt={48}>
36
+ Which language do you want to code in?
37
+ <StyledSelect
38
+ id="language-select"
39
+ aria-label="Select a language"
40
+ options={languageOptions}
41
+ onChange={(e) => onChange(e.target.value as languageOption)}
42
+ />
43
+ </Background>
44
+ );
45
+ };