docs: refactor the layout closer to the official document #100

ElderJames · 2020-05-09T17:20:36Z

fix #95

ElderJames · 2020-05-09T17:58:53Z

/preview

github-actions · 2020-05-09T17:59:06Z

lindexi · 2020-05-10T01:32:58Z

和你推荐一个很好用的机器人，代码审查代码风格机器人 https://github.com/marketplace/codefactor 可以自动审查代码里面风格不符合，包括换行空格，以及静态代码漏洞例如资源没释放，值可能是空

lindexi · 2020-05-10T01:36:31Z

components/button/AntButton.razor.cs

@@ -63,6 +66,7 @@ protected void SetClassMap()
            ClassMapper.Clear()
                .Add("ant-btn")
                .If($"{prefixName}-{this.Type}", () => !string.IsNullOrEmpty(Type))
+                 .If($"{prefixName}-danger", () => Danger)


看起来代码没对齐

lindexi · 2020-05-10T01:37:11Z

components/badge/AntBadge.razor.cs

        }
+
+        private string[] badgePresetColors =


推荐字段使用下划线开始

lindexi · 2020-05-10T01:39:21Z

components/menu/AntMenu.razor.cs

-        private IList<AntSubMenu> _openedSubMenus = new List<AntSubMenu>();
+        public void SelectItem(AntMenuItem item)
+        {
+            foreach (AntMenuItem menuitem in MenuItems.Where(x => x != item))


menu item 是两个词语，推荐使用 menuItem

lindexi · 2020-05-10T01:41:42Z

components/menu/AntMenu.razor.cs

+            base.OnInitialized();
+
+            if (InternalMode != AntMenuMode.Inline && _collapsed)
+                throw new ArgumentException($"{nameof(AntMenu)} in the {Mode} mode cannot be {nameof(Collapsed)}");


推荐告诉开发者，什么值才是符合预期的

lindexi · 2020-05-10T01:44:00Z

docs/introduce.zh-CN.md

@@ -24,30 +27,30 @@

 - 🌈 提炼自企业级中后台产品的交互语言和视觉风格。
 - 📦 开箱即用的高质量 Razor 组件，可在多种托管方式共享。
- 💕 支持基于 WebAssembly 的客户端和基于 SignalR 的服务端 UI 事件交互。
+- 💕 支持基于 WebAssembly 的客户端和基于 SignalR 的服务端UI事件交互。


我认为 UI 这个单词前后需要添加空格

lindexi · 2020-05-10T01:44:50Z

docs/introduce.zh-CN.md

@@ -57,15 +60,15 @@

 ## 🎨 设计规范

-与 Ant Design 设计规范定期同步，你可以在线查看[同步日志](https://github.com/ant-design-blazor/ant-design-blazor/actions?query=workflow%3A%22Style+sync+Bot%22)。
+与 Ant Design 设计规范定期同步，你可以在线查看[同步日志](https://github.com/ElderJames/ant-design-blazor/actions?query=workflow%3A%22Style+sync+Bot%22)。


这里不是 ant-design-blazor 组织？

Suggested change

与 Ant Design 设计规范定期同步，你可以在线查看[同步日志](https://github.com/ElderJames/ant-design-blazor/actions?query=workflow%3A%22Style+sync+Bot%22)。

与 Ant Design 设计规范定期同步，你可以在线查看[同步日志](https://github.com/ant-design-blazor/ant-design-blazor/actions?query=workflow%3A%22Style+sync+Bot%22)。

lindexi · 2020-05-10T01:45:29Z

docs/introduce.zh-CN.md

  ```
-  $ git clone git@github.com:ant-design-blazor/ant-design-blazor.git
+  $ git clone git@github.com:ElderJames/ant-design-blazor.git


这里是不是需要修改为组织名？将 ElderJames 替换为 ant-design-blazor 呢

lindexi · 2020-05-10T01:45:48Z

docs/introduce.zh-CN.md

@@ -117,13 +118,14 @@

 ## 🗺 开发路线

-查看 [这个 issue](https://github.com/ant-design-blazor/ant-design-blazor/issues/21) 来了解我们 2020 年的开发计划。
+查看 [这个 issue](https://github.com/ElderJames/ant-design-blazor/issues/21) 来了解我们 2020 年的开发计划。


这里是不是需要修改为组织名？将 ElderJames 替换为 ant-design-blazor 呢

lindexi · 2020-05-10T01:46:04Z

docs/introduce.zh-CN.md


-如果你希望参与贡献，欢迎 [Pull Request](https://github.com/ant-design-blazor/ant-design-blazor/pulls)，或给我们 [报告 Bug](https://github.com/ant-design-blazor/ant-design-blazor/issues/new) 。
+如果你希望参与贡献，欢迎 [Pull Request](https://github.com/ElderJames/ant-design-blazor/pulls)，或给我们 [报告 Bug](https://github.com/ElderJames/ant-design-blazor/issues/new) 。


是否需要将这个文档全局将 ElderJames 替换为 ant-design-blazor 呢

lindexi · 2020-05-10T01:46:56Z

site/AntBlazor.Docs.Build.CLI/Command/GenerateDemoJsonCommand.cs

+                string configFileDirectory = Path.Combine(Directory.GetCurrentDirectory(), output);
+                if (!Directory.Exists(configFileDirectory))
+                {
+                    Directory.CreateDirectory(configFileDirectory);


在 Directory.CreateDirectory 内部判断了文件夹是否存在，所以放心调用，不需要先判断文件不存在

lindexi · 2020-05-10T01:50:22Z

site/AntBlazor.Docs.Build.CLI/Command/GenerateMenuJsonCommand.cs

+
+                if (string.IsNullOrEmpty(docsDir) || !Directory.Exists(docsDir))
+                {
+                    Console.WriteLine("Invalid docsDir.");


这里有点迷的是，如果用户传入的是相对路径，但是工作目录不对，例如这个应用是被其他应用调起的，此时调试的时候将会比较坑。如我本地测试传入 xx\xx 是对的，但是服务器测试就是炸了，这是为什么？一个原因是相对路径会根据工作路径决定绝对路径，而此时的错误信息里面只是输出 Invalid docsDir. 此时很难猜到是为什么

推荐的写法是 docsDir = System.IO.Path.GetFullPath(docsDir ) 输出的时候是 Console.WriteLine("docsDir = {docsDir } not found.");

lindexi · 2020-05-10T01:55:26Z

site/AntBlazor.Docs.Build.CLI/Command/GenerateMenuJsonCommand.cs

+        private void GenerateFiles(string demoDirectory, string docsDirectory, string output)
+        {
+            DirectoryInfo demoDirectoryInfo = new DirectoryInfo(demoDirectory);
+            if (demoDirectoryInfo.Attributes != FileAttributes.Directory)


印象中这个判断是有坑的，应该通过 Directory.Exists 判断才比较稳哈

这个属性的判断需要使用 HasFlag 或 & 的方法，不能使用相等判断，原因是这个特性可以包括是文件夹同时是压缩文件夹，此时的值就不等于 FileAttributes.Directory 了

lindexi · 2020-05-10T01:56:05Z

site/AntBlazor.Docs.Build.CLI/Command/GenerateMenuJsonCommand.cs

+
+                File.WriteAllText(configFilePath, json);
+                Console.WriteLine("Generate demo file to {0}", configFilePath);
+            }


这个方法太长了

lindexi · 2020-05-10T01:57:07Z

site/AntBlazor.Docs.Build.CLI/Program.cs

+            }
+            catch (Exception e)
+            {
+                Console.WriteLine($"An error occurred. {e.Message}");


此时推荐使用 e.ToString 方法，这里输出的信息更全

lindexi · 2020-05-10T01:58:30Z

site/AntBlazor.Docs.Build.CLI/Utils/ConsoleUtils.cs

+            Console.ForegroundColor = currentForegroundColor;
+        }
+
+        public static void WriteWelcome()


这个好像是多余的方法

lindexi · 2020-05-10T01:59:14Z

site/AntBlazor.Docs.Build.CLI/Utils/DirectoryProvider.cs

+    {
+        private readonly PlatformInformationArbiter _platformInformation;
+
+        public string TmpDirectory => _platformInformation.GetValue(


好奇为什么不用 Path.GetTempPath() 代替

lindexi · 2020-05-10T02:02:57Z

site/AntBlazor.Docs/Services/ConcurrentCache.cs

+{
+    public class ConcurrentCache<TKey, TValue>
+    {
+        private readonly ConcurrentDictionary<TKey, Lazy<TValue>> dictionary;


推荐字段使用下划线开头

lindexi · 2020-05-10T02:04:03Z

site/AntBlazor.Docs/Services/ConcurrentCache.cs

+        {
+            get
+            {
+                if (dictionary.ContainsKey(key))


注意，这句话是不对的。你在 1 线程判断存在，在你准备调用 dictionary[key].Value 返回的时候，在 2 线程更改删除了这个内容

请使用 TryGetValue 代替

* docs: add cli for building demo structured file * docs: cli improvement * docs: generate demo page * fix: style of components page * docs: add prism to mack source code highlight * feat: add menu2json command for cli * fix: markdown highlight * feat: fetch menu data from cli output files * fix: cli * docs: add avatar demo * docs: add button demos * docs: add component-scope style * docs: fix style * docs: add badge demos * fix: rebase conflict * docs: refactor layout * docs: fix navigation * docs: fix rebase conflict * docs: add AntAffix for sider menu * docs: fix affix error * docs: fix rebase confilct

pr-triage bot added the PR: unreviewed label May 9, 2020

ElderJames added 18 commits May 10, 2020 01:37

docs: add cli for building demo structured file

07c1827

docs: cli improvement

c2f83e7

docs: generate demo page

22a7095

fix: style of components page

a43bc00

docs: add prism to mack source code highlight

497776a

feat: add menu2json command for cli

afe0c03

fix: markdown highlight

df928c6

feat: fetch menu data from cli output files

b9a021a

fix: cli

3c1aac0

docs: add avatar demo

6bcefb4

docs: add button demos

998d565

docs: add component-scope style

b9198aa

docs: fix style

52ad335

docs: add badge demos

d4f743c

fix: rebase conflict

740753e

docs: refactor layout

1c7f62e

docs: fix navigation

e3cb6f4

docs: fix rebase conflict

3689cbd

ElderJames force-pushed the docs/refactor branch from 8a8330a to 3689cbd Compare May 9, 2020 17:37

docs: add AntAffix for sider menu

90f8633

lindexi reviewed May 10, 2020

View reviewed changes

components/badge/AntBadge.razor.cs

}

private string[] badgePresetColors =

Copy link

Contributor

lindexi May 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

推荐字段使用下划线开始

lindexi reviewed May 10, 2020

View reviewed changes

ElderJames added 2 commits May 10, 2020 12:55

docs: fix affix error

2845c4e

docs: fix rebase confilct

7a92ee9

ElderJames merged commit e19a0b7 into master May 10, 2020

ElderJames deleted the docs/refactor branch May 10, 2020 07:42

pr-triage bot added PR: merged and removed PR: unreviewed labels May 10, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: refactor the layout closer to the official document #100

docs: refactor the layout closer to the official document #100

ElderJames commented May 9, 2020

ElderJames commented May 9, 2020

github-actions bot commented May 9, 2020 •

edited

lindexi commented May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

lindexi May 10, 2020

	与 Ant Design 设计规范定期同步，你可以在线查看[同步日志](https://github.com/ElderJames/ant-design-blazor/actions?query=workflow%3A%22Style+sync+Bot%22)。
	与 Ant Design 设计规范定期同步，你可以在线查看[同步日志](https://github.com/ant-design-blazor/ant-design-blazor/actions?query=workflow%3A%22Style+sync+Bot%22)。


		如果你希望参与贡献，欢迎 [Pull Request](https://github.com/ant-design-blazor/ant-design-blazor/pulls)，或给我们 [报告 Bug](https://github.com/ant-design-blazor/ant-design-blazor/issues/new) 。
		如果你希望参与贡献，欢迎 [Pull Request](https://github.com/ElderJames/ant-design-blazor/pulls)，或给我们 [报告 Bug](https://github.com/ElderJames/ant-design-blazor/issues/new) 。

docs: refactor the layout closer to the official document #100

docs: refactor the layout closer to the official document #100

Conversation

ElderJames commented May 9, 2020

ElderJames commented May 9, 2020

github-actions bot commented May 9, 2020 • edited

lindexi commented May 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 9, 2020 •

edited